Skip to content

Commit

Permalink
Update instructions for references
Browse files Browse the repository at this point in the history
  • Loading branch information
mjackson committed Sep 11, 2024
1 parent 042608b commit fbbe8fe
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 22 deletions.
6 changes: 3 additions & 3 deletions references/cpp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@

This folder contains a simple reference C++ executable that uses milo.

In order to build it you need [Clang] and [make].
In order to build it you need [Clang] and [cargo-make].

To build it simply execute:

```bash
make
cargo make
```

This will generate two executables in the `dist` directory `reference-debug` and `reference-release`.

The debug version will also show the parser state changes.

[Clang]: https://clang.llvm.org/
[make]: https://www.gnu.org/software/make/
[cargo-make]: https://sagiegurari.github.io/cargo-make/
8 changes: 4 additions & 4 deletions references/rust/Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions references/rust/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@

This folder contains a simple reference Rust executable that uses milo.

In order to build it you need [make].
In order to build it you need [cargo-make].

To build it simply execute:

```bash
make
cargo make
```

This will generate two executables in the `dist` directory `reference-debug` and `reference-release`.

The debug version will also show the parser state changes.

[make]: https://www.gnu.org/software/make/
[cargo-make]: https://sagiegurari.github.io/cargo-make/
16 changes: 4 additions & 12 deletions references/wasm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,16 @@

This folder contains a simple reference Javascript file that uses milo (via WebAssembly).

In order to build it you need [make].
In order to build it you need [cargo-make].

To build it simply execute:

```bash
make
cargo make
```

This will compile milo as WebAssembly in `dist/debug` and `dist/release`.
This will generate two executables in the `dist` directory `reference-debug` and `reference-release`.

The debug version will also show the parser state changes.

To execute the sample executable you can run:

```bash
node index.mjs [--debug|--release]
```

By default, it executes in release mode.

[make]: https://www.gnu.org/software/make/
[cargo-make]: https://sagiegurari.github.io/cargo-make/

0 comments on commit fbbe8fe

Please sign in to comment.