From 7bb1a2ec63db20b249df937555b1ebd264fb36af Mon Sep 17 00:00:00 2001 From: IrosTheBeggar Date: Mon, 12 Jun 2017 15:40:50 -0400 Subject: [PATCH] Improved install docs --- docs/install.md | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/docs/install.md b/docs/install.md index c9e1f88..d718231 100644 --- a/docs/install.md +++ b/docs/install.md @@ -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)