From 5aa1028318de2551ae406a24465c40b5957e108f Mon Sep 17 00:00:00 2001 From: Corey Montella Date: Mon, 15 May 2017 15:12:13 -0700 Subject: [PATCH] Install guide --- install.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 install.md diff --git a/install.md b/install.md new file mode 100644 index 0000000..644032e --- /dev/null +++ b/install.md @@ -0,0 +1,29 @@ +# Installation + +Install [Node](https://nodejs.org/en/download/) for your platform, then clone and build the Eve starter repository: + +``` +git clone git@github.com:witheve/eve-starter.git +cd eve-starter +npm install +``` + +## Usage + +You can start the program switcher, which allows you to browse included example programs: + +``` +npm start +``` + +Or you can run a specific program by providing its path as an argument: + +``` +npm start -- path/to/program.eve +``` + +To view other functionality of the starter, run + +``` +npm start -- --help +``` \ No newline at end of file