Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
zeim839 authored Nov 19, 2024
1 parent 8ab1aeb commit 7846401
Showing 1 changed file with 49 additions and 0 deletions.
49 changes: 49 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,50 @@
# nes-tools

NES emulator toolchain based on [ObaraEmmanuel/NES](https://github.com/ObaraEmmanuel/NES).

## Dependencies
This project requires the [SDL2](https://www.libsdl.org/) library to be installed in a searchable path (i.e. within your OS `PATH` variable). Additionally, you'll need a C compiler and [Make](https://www.gnu.org/software/make/).

⚠️⚠️BEWARE OF BUGS⚠️⚠️

Windows support coming soon...

## Install

Clone the repository
```
https://github.com/zeim839/nes-tools.git
```

Navigate to the project directory and run the configuration script
```
cd nes-tools
./configure
```

Build and install
```
make install
```

Run the emulator
```
nes-tools help
```

### Uninstall
```
make uninstall
```

## Usage

The emulator is currently designed to support mapper #0 game ROMs (see [NES Directory](https://nesdir.github.io/mapper0.html) for a complete list of supported games), which you'll need to install independently. To run a ROM, call the `nes-tools` executable as follows:
```
nes-tools run [path/to/rom/]
```

nes-tools supports [iNES](https://www.nesdev.org/wiki/INES) format cartridge ROMs.

## License
[MIT](LICENSE)

0 comments on commit 7846401

Please sign in to comment.