-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
49 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) |