Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update references readmes #10

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update references readmes #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions references/cpp/README.md
View file
Open in desktop
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
View file
Open in desktop

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
View file
Open in desktop
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
View file
Open in desktop
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/