rs-nes

(β˜… 99)

A work-in-progress NES emulator written in Rust

  • .gitignore
  • .rustfmt.toml
  • .travis.yml
  • Cargo.lock
  • Cargo.toml
  • LICENSE
  • README.md

# Installation Guide

1. Get the code
git clone https://github.com/bgourlie/rs-nes

Downloads the entire project code from GitHub to your computer.

cd rs-nes

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
cd rs-nes-web

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

3. Rust

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
cargo run --bin native_client --release --features="native_client" -- path/to/rom.nes

Builds and then immediately runs the program.

βœ… If cargo build finishes without errors, it worked. The executable is created under target/.

Pulled directly from this repo's README.

// repository documentation