Skip to content

Commit f1dad74

Browse files
committed
add install
1 parent a9d4078 commit f1dad74

File tree

2 files changed

+54
-185
lines changed

2 files changed

+54
-185
lines changed

v0.3/install.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
layout: default
3+
title: Installation
4+
---
5+
6+
# Installation
7+
8+
Install [Node](https://nodejs.org/en/download/) for your platform, then clone and build the Eve starter repository:
9+
10+
```
11+
git clone https://github.com/witheve/eve-starter.git
12+
cd eve-starter
13+
npm install
14+
```
15+
16+
## Usage
17+
18+
In the eve-starter directory, you can launch the Program Switcher:
19+
20+
```
21+
npm start
22+
```
23+
24+
This will open your browser to the Program Switcher, which allows you can run the programs located in the `eve-starter/programs` directory. You can place your own `*.eve` files in this directory and run them from the Program Switcher.
25+
26+
### Running an Eve file
27+
28+
Eve documents are written in Markdown, where Eve code is embedded in code blocks. You can run a specific `*.eve` file by providing its path as an argument:
29+
30+
```
31+
npm start -- path/to/program.eve
32+
```
33+
34+
### Command Line Options
35+
36+
The command line interface accepts a number of configuration options, which can be displayed using the help command:
37+
38+
```
39+
npm start -- --help
40+
```
41+
42+
The available options include:
43+
44+
```
45+
-h, --help output usage information
46+
-W, --workspace <name>:<path> Search path(s) for programs
47+
-I, --include <path> Search path(s) for watchers
48+
-H, --headless Run the specified program in node instead of the browser. Requires a specified file
49+
-p, --port <number> Run the Eve server on an alternate port. Default <8000>
50+
-n, --no-open Don't automatically open Eve in the browser
51+
-f, --list-found List all programs and watchers found within their search paths
52+
```
53+
54+

v0.3/install/index.html

Lines changed: 0 additions & 185 deletions
This file was deleted.

0 commit comments

Comments
 (0)