Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions install.md
Original file line number Diff line number Diff line change
@@ -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
```