|
| 1 | +# 𝜑-calculus playground |
| 2 | + |
1 | 3 | <img src="https://www.yegor256.com/images/books/elegant-objects/cactus.svg" height="100px" /> |
2 | 4 |
|
3 | 5 | Try [𝜑-calculus](https://www.eolang.org) online: [click here](https://polystat.github.io/try-phi/). |
@@ -28,42 +30,54 @@ Right now we implement it as a term rewriting system with the following features |
28 | 30 | ## How to contribute |
29 | 31 |
|
30 | 32 | This project is powered by [Elm language](https://elm-lang.org). |
31 | | -To develop locally, install Elm, clone this repository: |
| 33 | +To develop locally: |
32 | 34 |
|
33 | | -```sh |
34 | | -$ git clone git@github.com:polystat/try-phi.git |
35 | | -``` |
| 35 | +1. [Install](https://guide.elm-lang.org/install/elm.html) Elm |
36 | 36 |
|
37 | | -Then go into the cloned repository and build the project: |
| 37 | +1. Clone this repository: |
| 38 | + ```sh |
| 39 | + git clone git@github.com:polystat/try-phi.git |
| 40 | + ``` |
38 | 41 |
|
39 | | -```sh |
40 | | -$ cd try-phi |
41 | | -$ elm make src/Main.elm --output=src/Main.js |
42 | | -``` |
| 42 | +1. Then `cd` into the cloned repository |
| 43 | + ```sh |
| 44 | + git clone git@github.com:polystat/try-phi.git |
| 45 | + ``` |
| 46 | +1. Run the project |
43 | 47 |
|
44 | | -Now run Elm reactor: |
45 | 48 |
|
46 | | -``` |
47 | | -$ elm reactor |
48 | | -``` |
| 49 | +## Run |
49 | 50 |
|
50 | | -You should see a message like this one: |
| 51 | +### Option 1 with auto-reload on `.elm`-file changes: |
| 52 | +* Install [elm-live](https://github.com/wking-io/elm-live) |
51 | 53 |
|
52 | | -``` |
53 | | -Go to http://localhost:8000 to see your project dashboard. |
54 | | -``` |
| 54 | +* Run (on Windows, use `cmd`) |
| 55 | + ```sh |
| 56 | + elm-live src/Main.elm -- --o=src/Main.js |
| 57 | + ``` |
55 | 58 |
|
56 | | -You can then go there to `src > index.html`. |
57 | | -Or just go to http://localhost:8000/src/index.html |
| 59 | +* Go to http://localhost:8000/src/index.html |
58 | 60 |
|
59 | | -Whenever you modify the code, rebuild the JS file: |
| 61 | +### Option 2 |
| 62 | +1. Run Elm reactor: |
| 63 | + ``` |
| 64 | + elm reactor |
| 65 | + ``` |
60 | 66 |
|
61 | | -```sh |
62 | | -$ elm make src/Main.elm --output=src/Main.js |
63 | | -``` |
| 67 | +1. You should see a message like this one: |
| 68 | + ``` |
| 69 | + Go to http://localhost:8000 to see your project dashboard. |
| 70 | + ``` |
| 71 | +1. Now, go to http://localhost:8000/src/index.html |
64 | 72 |
|
65 | | -And reload the page :) |
| 73 | +1. Whenever you modify the code: |
| 74 | + 1. Rebuild the `Main.js` file |
| 75 | + ```sh |
| 76 | + elm make src/Main.elm --output=src/Main.js |
| 77 | + ``` |
| 78 | + 1. And reload the page :) |
66 | 79 |
|
67 | | -If you want to see documentation, install [elm-doc-preview](https://github.com/dmy/elm-doc-preview) |
| 80 | +## Documentation |
| 81 | +* Install [elm-doc-preview](https://github.com/dmy/elm-doc-preview) |
68 | 82 |
|
69 | | -In terminal, type `edp` |
| 83 | +* In terminal, type `edp` |
0 commit comments