From eacc32f171c378f2df6919fde5189c482a3a1325 Mon Sep 17 00:00:00 2001 From: knotteye Date: Sat, 4 Jul 2020 10:06:52 -0500 Subject: [PATCH] Add contributing instructions That I will follow in the future.. --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ffc5a77..4771a51 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,13 @@ 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 git clone https://gitlab.com/knotteye/satyr.git cd satyr npm install npm run setup +npm run build ``` Follow the instructions after setup runs. @@ -15,3 +16,10 @@ Follow the instructions after setup runs. ```bash npm start ``` + +## Contributing + +1. Fork the repository +2. Create new feature branch +3. Write Code +4. Create an request to merge back into develop