-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #86 from mackmudge/master
Fixing documentation errors.
- Loading branch information
Showing
5 changed files
with
80 additions
and
81 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 |
---|---|---|
@@ -0,0 +1,42 @@ | ||
# Project Name | ||
|
||
<!--- | ||
Q What is this project? | ||
Q How will this help others with completing the task? | ||
Q What were the steps before using this automation and what are the steps after? | ||
---> | ||
|
||
|
||
### Things you will need to get it running: 📈 | ||
- | ||
- | ||
- | ||
|
||
|
||
### Additional packages: 📝 | ||
<!---Only add the names of packages which have to be installed externally!---> | ||
- _package names_ | ||
|
||
#### How do I install additional packages? 🤨 | ||
|
||
- Make sure you have **nodejs** installed on your system. If you haven't yet go to [nodejs.org](https://nodejs.org "go to nodejs.org") | ||
|
||
- If you want to install dependecies with **npm** | ||
- Check for **yarn.lock**. If it is in the root directory then DELETE **yarn.lock**. | ||
- Now, run `npm install`. This will install all of the dependencies. | ||
|
||
- If you want to install dependencies with **yarn**. | ||
- Check for **package-lock.json**. If it is in the root directory then DELETE **package-lock.json**. | ||
- Now, run `yarn install` or `yarn`. This will install all of the dependencies. | ||
|
||
|
||
### How do I use this program? 💻 | ||
- If you want to run with **npm** | ||
- Run `npm start` | ||
- If you want to run with **yarn** | ||
- Run `yarn start` | ||
|
||
--- | ||
|
||
### Made By : | ||
[<name of the creator/s >](Your profile link "go to creator profile") |
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 |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# Project Name | ||
|
||
<!--- | ||
Q What is this project? | ||
Q How will this help others with completing the task? | ||
Q What were the steps before using this automation and what are the steps after? | ||
---> | ||
|
||
### Things you will need to get it running: 📈 | ||
- | ||
- | ||
- | ||
|
||
### Additional packages: 📝 | ||
<!---Only add the names of packages which have to be installed externally!---> | ||
- _package names_ | ||
|
||
#### How do I install additional packages? 🤨 | ||
- Make sure you have python package manager (**pip**) installed on your system | ||
- Go to command line and type ```pip install <library name>``` { _pip3_ on mac } | ||
- For detailed information see [python's official tutorial on how to install packages](https://packaging.python.org/tutorials/installing-packages/) | ||
|
||
### How do I use this program? 💻 | ||
- Steps to get your program running as intended | ||
- | ||
|
||
--- | ||
|
||
### Made By: | ||
[<name of the creator/s >](Your profile link) |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
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