diff --git a/README.md b/README.md index f6981f2..32a4001 100644 --- a/README.md +++ b/README.md @@ -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)