Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
djrideout committed Oct 14, 2024
1 parent d0fed70 commit 3419b6f
Showing 1 changed file with 23 additions and 4 deletions.
27 changes: 23 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,19 +17,38 @@ CHIP-8 interpreter written in Rust. Targets CHIP-8, SUPER-CHIP (Modern), SUPER-C

# Build requirements
- [Rust/Cargo](https://www.rust-lang.org/tools/install)
- [Node.js if building for web](https://nodejs.org/en)

# Run interpreter
# Run interpreter (native)
`cargo run -- <options>`

# Run test suite
`cargo test`
# Run interpreter (web)
```
cd web/view
npm install
npm run dev:full
```

To rebuild wasm only:
`npm run build:wasm`

# Build & run (release)
# Build & run (release, native)
```
cargo build --release
./target/release/chippy.exe <options>
```

# Build & run (release, web)
```
cd web/view
npm install
npm run build:full
npm run preview
```

# Run test suite
`cargo test`

# Debugging in VSCode
There is a VSCode launch config for debugging using LLDB in `.vscode/launch.json`.
To use it, modify the args in `.vscode/launch.json` with the options you want from above
Expand Down

0 comments on commit 3419b6f

Please sign in to comment.