You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-42Lines changed: 14 additions & 42 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,61 +6,35 @@
6
6
7
7
Eve is a programming language and IDE based on years of research into building a human-first programming platform. You can play with Eve online here: [play.witheve.com](http://play.witheve.com/).
8
8
9
-
[](http://play.witheve.com/)
9
+
[](http://play.witheve.com/#/examples/flappy.eve)
10
10
11
-
## Installation
12
-
13
-
### From Source
14
-
15
-
You'll need a recent [node.js](https://nodejs.org) for your platform. Download the Eve source either by cloning this repository:
11
+
## How to use Eve
16
12
13
+
Install [Node](https://nodejs.org/en/download/) for your platform, then install Eve:
17
14
18
15
```
19
-
git clone https://github.com/witheve/Eve.git
16
+
npm install -g witheve
20
17
```
21
18
22
-
or you can [download](https://github.com/witheve/Eve/archive/master.zip)the Eve source directly. To build and run Eve, run the following commands in the root Eve directory:
19
+
Use the `eve` command to run a `*.eve` program:
23
20
24
21
```
25
-
npm install
26
-
npm start
22
+
eve myProgram.eve
27
23
```
28
24
29
-
Then open `http://localhost:8080/` in your browser.
30
-
31
-
### From npm
32
-
33
-
Alternatively, you can download Eve directly from npm with the following command:
25
+
For more on running Eve, see the [documentation](http://docs.witheve.com/handbook/running/).
34
26
35
-
```
36
-
npm install witheve
37
-
```
38
-
39
-
### From Docker
27
+
You can alternatively install Eve from source ([mac](http://docs.witheve.com/handbook/mac/), [windows](http://docs.witheve.com/handbook/windows/), [linux](http://docs.witheve.com/handbook/linux/)), or with [Docker](http://docs.witheve.com/handbook/docker/).
40
28
41
-
First, [download](https://www.docker.com/products/docker) and install Docker for your platform. To download and install the Eve container, run the following command:
42
-
43
-
```
44
-
docker run -p 8080:8080 witheve/eve
45
-
```
46
-
47
-
## How to use Eve
29
+
## Learning Eve
48
30
49
31
You can learn about Eve with the following resources:
50
32
51
-
-[Play with Eve in your browser](http://play.witheve.com/) (use Chrome for best results)
33
+
-[Read the Quick Start Tutorial](http://play.witheve.com/) (use Chrome for best results)
-[Eve Language Handbook (draft)](http://docs.witheve.com)
54
-
55
-
*Please let us know what kind of documents would be the most helpful as you begin your journey with Eve*. We want our documentation to be a highlight of the Eve experience, so any suggestions are greatly appreciated.
By default, Eve executes on the client browser. To instead execute your program on the server, launch Eve with the `--server` flag:
60
-
61
-
```
62
-
npm start -- --server
63
-
```
37
+
Also, the [mailing list archive](https://groups.google.com/forum/#!forum/eve-talk) is a good resource for help and inspiration. In particular, the [Puzzles & Paradoxes series](https://groups.google.com/forum/#!searchin/eve-talk/Puzzles$20$26$20Paradoxes%7Csort:date) answers a lot of questions beginners face about the Eve langauge.
64
38
65
39
## Get Involved
66
40
@@ -75,17 +49,15 @@ The Eve community is small but constantly growing, and everyone is welcome!
75
49
76
50
### How to Contribute
77
51
78
-
The best way to contribute right now is to write Eve code and report your experiences. Let us know what kind of programs you’re trying to write, what barriers you are facing in writing code (both mental and technological), and any errors you encounter along the way. Also, let us know what you love! What features are your favorite?
79
-
80
-
Another way to really help us is to host your `*.eve` files on Github, so we can get Eve recognized as an official language in the eyes of Github. Be sure to also send us a link to your repo!
52
+
The best way to contribute right now is to write Eve code and report your experiences. [Let us know](https://groups.google.com/forum/#!forum/eve-talk) what kind of programs you’re trying to write, what barriers you are facing in writing code (both mental and technological), and any errors you encounter along the way.
81
53
82
54
### How to File an Issue
83
55
84
56
Please file any issues in this repository. Before you file an issue, please take a look to see if the issue already exists. When you file an issue, please include:
85
57
86
58
1. The steps needed to reproduce the bug
87
59
2. Your operating system and browser.
88
-
3. If applicable, the .*eve file that causes the bug.
60
+
3. If applicable, the `.*eve` file that causes the bug.
0 commit comments