diff --git a/README.md b/README.md index 32a4001..c127344 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,17 @@ -# nes-tools +
+

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/). +Windows support coming soon... ⚠️⚠️BEWARE OF BUGS⚠️⚠️ +
-Windows support coming soon... +## 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/). ## Install @@ -46,5 +50,8 @@ nes-tools run [path/to/rom/] nes-tools supports [iNES](https://www.nesdev.org/wiki/INES) format cartridge ROMs. +## Contributing +All contributions are welcome and appreciated. Open an issue before proposing significant changes. + ## License [MIT](LICENSE)