-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
9bce231
commit e08270a
Showing
3 changed files
with
24 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,41 +1,54 @@ | ||
# _{Application Name}_ | ||
# _{TODOApplication Name}_ | ||
|
||
#### _{Brief description of application}, {Date of current version}_ | ||
#### _{TODOBrief description of application}, {TODODate of current version}_ | ||
|
||
#### By _**{List of contributors}**_ | ||
#### By _**{TODOList of contributors}**_ | ||
|
||
## Description: | ||
|
||
_{This is a detailed description of your application. Its purpose and usage. Give as much detail as needed to explain what the application does, and any other information you want users or other developers to have. }_ | ||
_{TODOThis is a detailed description of your application. Its purpose and usage. Give as much detail as needed to explain what the application does, and any other information you want users or other developers to have. }_ | ||
|
||
## Site link | ||
|
||
_`[Click here](https://jeffchiudev.github.io/example-repo/)` to visit the site._ | ||
_`[Click here](https://jeffchiudev.github.io/TODOexample-repo/)` to visit the site._ | ||
|
||
|
||
## Setup/Installation Requirements: | ||
|
||
### Software Requirements: | ||
|
||
_1. Internet browser of choice. Chrome & Firefox are suggested_ | ||
_1. Internet browser of choice. Chrome is suggested._ | ||
|
||
_2. A code editor like VSCode or Atom to view or edit the codebase._ | ||
|
||
#### Open by downloading: | ||
|
||
### Open by downloading: | ||
|
||
_1. Download `[this](https://github.com/jeffchiudev/example-repo)` repository onto your computer by clicking the 'clone or download button'._ | ||
_2. Double click index.html to open it in your web browser._ | ||
|
||
_2. This page utilizes Node package manager and requires local files to be installed. Once you've cloned the repository and it's accompanying config files, use the following command `npm install` to install the necessary NPM files to display correctly._ | ||
|
||
_3. Double click index.html to open it in your web browser._ | ||
|
||
### Open via Bash/GitBash: | ||
|
||
_1. Open terminal window and navigate to/create desired repository location._ | ||
|
||
_2. Clone this repository onto your computer by using command:_ | ||
`git clone https://github.com/jeffchiudev/example-repo` | ||
`git clone https://github.com/jeffchiudev/TODOexample-repo` | ||
|
||
_3. In the directory where you've cloned the repository, open in Visual Studio Code with `code .` or preferred text editor._ | ||
|
||
## Testing Specifications: | ||
|
||
<details><summary>Click Here</summary> | ||
<p> | ||
|
||
| Description | Input | Ouput | | ||
|
||
</p> | ||
</details> | ||
|
||
## Known Bugs: | ||
|
||
_Currently optimized for desktop browsing. Smart device integration will be added soon._ | ||
|
@@ -47,10 +60,7 @@ _If there are any issues, I can be contacted at [email protected]_ | |
|
||
## Technologies Used: | ||
|
||
_{Tell me about the languages and tools you used to create this app. Assume that I know you probably used HTML and CSS. If you did something really cool using only HTML, point that out.}_ | ||
|
||
### License: | ||
_{TODOTell me about the languages and tools you used to create this app. Assume that I know you probably used HTML and CSS. If you did something really cool using only HTML, point that out.}_ | ||
|
||
_This extension is licensed under the MIT license._ | ||
|
||
Copyright (c) 2020 **_Jeff W. Chiu_** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.