pinky

(β˜… 810)

An NES emulator written in Rust

  • .gitignore
  • .gitmodules
  • .travis.yml
  • Cargo.toml
  • LICENSE-APACHE.txt
  • LICENSE-MIT.txt
  • README.md

# Installation Guide

1. Get the code
git clone https://github.com/koute/pinky

Downloads the entire project code from GitHub to your computer.

cd pinky

Moves into the project folder you just downloaded.

2. Rust

Medium Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
cargo build

Compiles the Rust project.

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

Pulled directly from this repo's README.

3. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd nes-testsuite/roms/holy_diver_batman/source

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

make

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation