Skip to content

Commit

Permalink
Merge pull request tonk-labs#13 from matthieuauger/fix-install
Browse files Browse the repository at this point in the history
fix install and document it
  • Loading branch information
goblinoats authored Mar 5, 2024
2 parents a5a1e2f + f4dd751 commit 02fa93d
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,15 @@ That's great! We are actively seeking contributions and are grateful for your su
The NES emulator will require modifications to output the transcript and snapshot its state in a format most suitable for proving. In the interest of developer velocity, we have gone ahead and forked the tetanes project. For now, it's a submodule.

Performance is nearly 60fps when using the release build. When running the binary, you can load a test_rom or play the freeware roms in play_rom

First, ensure that you have cloned the `tetanes` submodule

```
git submodule update --init
```

Then build tetanes

```
cd tetanes
Expand All @@ -45,7 +54,9 @@ cargo build
cargo run
```

Noir circuits should have tests being written for them. For those circuits that do have tests you can run them by [installing Noir](https://noir-lang.org/getting_started/nargo_installation) and then in the root folder for example ([/circuits/cpu](/circuits/cpu)) run:
If `cargo build`fails with `ld: library not found for -lSDL2` look at <https://github.com/PistonDevelopers/rust-empty/issues/175>

Noir circuits should have tests being written for them. For those circuits that do have tests you can run them by [installing Noir](https://noir-lang.org/docs/getting_started/installation/) and then in the root folder for example ([/circuits/cpu](/circuits/cpu)) run:
```
nargo test
```
Expand Down
1 change: 1 addition & 0 deletions tetanes
Submodule tetanes added at 1d7003

0 comments on commit 02fa93d

Please sign in to comment.