knotteye
/
satyr
Archived
1
0
Fork 0
Code Issues Pull Requests Releases 5 Wiki Activity

Add contributing instructions 

That I will follow in the future..
merge-requests/12/merge
knotteye 2020-07-04 10:06:52 -05:00
parent 303924e77e
commit eacc32f171
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -2,12 +2,13 @@
System dependencies: A stable version of node>=10, mysql3 (or a compatible implementation such as MariaDB), and ffmpeg >=4.2 System dependencies: A stable version of node>=10, mysql3 (or a compatible implementation such as MariaDB), and ffmpeg >=4.2
### Setup Instructions ### Build Instructions
```bash ```bash
git clone https://gitlab.com/knotteye/satyr.git git clone https://gitlab.com/knotteye/satyr.git
cd satyr cd satyr
npm install npm install
npm run setup npm run setup
npm run build
``` ```
Follow the instructions after setup runs. Follow the instructions after setup runs.
@ -15,3 +16,10 @@ Follow the instructions after setup runs.
```bash ```bash
npm start npm start
``` ```
## Contributing
1. Fork the repository
2. Create new feature branch
3. Write Code
4. Create an request to merge back into develop