Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
aelred committed Sep 22, 2024
1 parent 747884a commit 5f73ee5
Showing 1 changed file with 27 additions and 3 deletions.
30 changes: 27 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,30 @@
A NES emulator written in Rust.
A NES emulator written in Rust, go to [nes.ael.red](https://nes.ael.red) to see it in action!

# Quickstart

To run locally, [install Just](https://just.systems/man/en/packages.html), get a NES ROM file and run:

```bash
just run <path to .nes ROM file>
```
$ cargo install --path .
$ nes-rust myrom.nes

If you need a NES ROM, try the [Alwa's Awakening demo](https://eldenpixels.itch.io/alwas-awakening-the-8-bit-edition#:~:text=944%20kB-,Download%20demo,-Download).

To run the web version, run:

```bash
just serve
```

And navigate to [http://localhost:8080](http://localhost:8080).

# Runtimes

The emulator supports two "runtimes": [SDL](#sdl) and [web](#web).

- SDL: Runs locally on your computer using SDL 2.
- Web: Runs in the browser using WASM, configured in [./web](./web).

# Deployment

The emulator is deployed to the web with GitHub pages in [deploy.yml](./.github/workflows/deploy.yml), using infrastructure provisioned with terraform in [./deploy/infrastructure](./deploy/infrastructure). It's available at [nes.ael.red](https://nes.ael.red).

0 comments on commit 5f73ee5

Please sign in to comment.