moon
/
enigma-bbs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add node instructions for newbs

This commit is contained in:
Bryan Ashby 2016-01-18 09:50:16 -07:00
parent 12414d0d7a
commit 3fcec210ef
1 changed files with 16 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/index.md
View File

@ -8,9 +8,21 @@ TL;DR? This should get you started...
* [Node.js](https://nodejs.org/) version **v0.12.2 or higher** (v4.2+ is recommended)
* [io.js](https://iojs.org/) should also work, though I have not yet tested this.
* :information_source: It is suggested to use [nvm](https://github.com/creationix/nvm) to manage your Node/io.js installs
* Windows users will need additional dependencies installed for the `npm install` step in order to compile native binaries:
* A recent copy of Visual Studio (Express editions OK)
* Python 2.7.x
* **Windows users will need additional dependencies installed** for the `npm install` step in order to compile native binaries:
* A recent copy of Visual Studio ([Visual Studio Express](https://www.visualstudio.com/en-us/products/visual-studio-express-vs.aspx) editions OK)
* [Python](https://www.python.org/downloads/) 2.7.x
## New to Node
If you're new to Node.js and/or do not care about Node itself and just want to get ENiGMA½ running these steps should get you going on most \*nix type enviornments:
```bash
curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.30.1/install.sh | bash
nvm install 4.2.4
nvm use 4.2.4
```
If the above completed without errors, you should now have `nvm`, `node`, and `npm` installed and in your environment.
## Clone
```bash
@ -19,6 +31,7 @@ git clone https://github.com/NuSkooler/enigma-bbs.git
## Install Node Modules
```bash
cd enigma-bbs
npm install
```