mirrors/mStream
3
0
Fork 0
mirror of https://github.com/IrosTheBeggar/mStream.git synced 2025-10-27 07:31:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improved install docs

Browse Source
This commit is contained in:
IrosTheBeggar 2017-06-12 15:40:50 -04:00
parent 533577fd8e
commit 7bb1a2ec63
1 changed files with 6 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/install.md
View File

@ -8,6 +8,7 @@ mStream has the following dependencies:
* Python 2
* GCC and G++
* node-gyp
* git
**Install NodeJS**
@ -26,16 +27,7 @@ sudo npm install -g node-gyp
**Install mStream**
Install through NPM
```shell
sudo npm install -g mstream
cd /path/to/your/music
mstream
```
Or Install through Git
Install mStream with git. You can install mStream from npm, but this has been known to cause errors
```shell
git clone https://github.com/IrosTheBeggar/mStream.git
@ -48,3 +40,7 @@ sudo npm link
```
Test it by running `mstream` in the terminal. Make sure it's working by checking out http://localhost:3000/
**Configure mStream**
[mStream can be configured with command line arguments.](cli_arguments.md)