Skip to content

Commit d1778ad

Browse files
doc(README): update Usage section
1 parent 36b0cfe commit d1778ad

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,20 @@ installed:
2727
## Usage
2828

2929
### Web Interface
30-
Run `pnpm build-web` to build the web interface. This will create a `build`
30+
It's accessible on Github Pages [here](https://aidandenlinger.github.io/wathon/)!
31+
32+
To run it locally, run `pnpm build-web` to build the web interface. This will create a `build`
3133
folder containing an `index.html` file and the needed javascript. To access
3234
this, I'd recommend going into the `build` folder and running
3335
`python -m http.server` if you have python3 installed on your system. This
3436
will launch a local web server, and you can access the compiler at
3537
`localhost:8000`.
3638

3739
### Command Line Interface
40+
41+
> **Warning**
42+
> The CLI interface wasn't tested very much - it should work, but I'd highly suggest the web interace.
43+
3844
Run `pnpm build-cli` to build a command line program. This will generate files
3945
in the `cli` folder. Once in the `cli` folder, you can run commands such as
4046
`node node-main.js "1+1"` to compile the program "1+1" and see the compiled

0 commit comments

Comments
 (0)