lasers
/
FreeTube
mirror of https://github.com/FreeTubeApp/FreeTube
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update CONTRIBUTING.md

This commit is contained in:
Preston 2019-08-27 18:33:11 +00:00 committed by GitHub
parent 6c88b7dcc3
commit accc21ea7d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
CONTRIBUTING.md
View File

@ -15,45 +15,4 @@ Please follow these guidlines before sending your pull request and making contri
# Setting up Your Environment
Here's how to get your environment setup. You will need Git and NPM installed on your system.
Clone down the repositoy:
```
git clone https://github.com/FreeTubeApp/FreeTube.git
```
Install Dependencies:
```
npm install
```
Install Dev Dependencies:
```
npm install --only=dev
```
Run the application:
```
npm start
```
Make / Package application:
Windows (Requires Wine on Linux):
```
npm run make:win
```
Mac:
```
npm run make:mac:zip
```
Linux (Requires deb and rpm to be installed):
```
npm run make:linux:x64
```
Other commands are available in the `package.json` file for making specific packages. Refer to [package.json](https://github.com/FreeTubeApp/FreeTube/blob/development/package.json) for instructions.
I will update this document when necessary. Anyone who has questions or suggestions on this document are welcome to create an issue or pull request.
Check out the [wiki](https://github.com/FreeTubeApp/FreeTube/wiki/Environment-Setup-and-Packaging) page to learn how to setup your environment and create packages.