diff options
| author | Anthony Wang | 2020-05-19 15:12:54 -0500 |
|---|---|---|
| committer | GitHub | 2020-05-19 15:12:54 -0500 |
| commit | f75f7eb618f7d2a1946257da69324f1d4af230da (patch) | |
| tree | eb74404a50241e41f00cff8485220244b97245e6 | |
| parent | afe538d6ddf406c8afbbfd593e4898b0bee5ef89 (diff) | |
Update README.md
| -rw-r--r-- | README.md | 42 |
1 files changed, 23 insertions, 19 deletions
@@ -8,7 +8,7 @@ EMULATOR ``` -A nearly complete NES emulator in a single 700-line C++ source file, based on [LaiNES](https://github.com/AndreaOrru/LaiNES). +A nearly complete NES emulator in a single 750-line C++ source file, based on [LaiNES](https://github.com/AndreaOrru/LaiNES). ``` cloc main.cpp @@ -29,24 +29,9 @@ C++ 1 6 60 757 - Savestates (beta, expect bugs) - Extremely compact: only 700 lines in one source file with no dependencies -## Requirements -- C++11 -- SDL2 - -## Building -### *nix systems -```sh -git clone --recursive https://github.com/Ta180m/BadNES && cd BadNES -g++ main.cpp -o badnes -std=c++11 -lSDL2main -lSDL2 -O3 -``` - -### Windows -```sh -git clone --recursive https://github.com/Ta180m/BadNES && cd BadNES -g++ main.cpp -o badnes -std=c++11 -IC:\mingw\include\SDL2 -LC:\mingw\lib -w -Wl,-subsystem,windows -lmingw32 -lSDL2main -lSDL2 -O3 -``` - ## Usage +First, head over to the release tab and grab a release. Releases marked as `beta` may be unstable! + ### *nix systems ```sh ./badnes [path to ROM] @@ -60,6 +45,8 @@ Alternatively, use badnes.exe [path to ROM] ``` +If it doesn't work you can also build it yourself, as described below. + ## Controls UP - UP DOWN - DOWN @@ -84,6 +71,23 @@ BadNES implements the most common mappers, which should be enough for a good per You can check the compatibility for each ROM in the following list: http://tuxnes.sourceforge.net/nesmapper.txt +## Building +### Requirements +- C++11 +- SDL2 + +### *nix systems +```sh +git clone --recursive https://github.com/Ta180m/BadNES && cd BadNES +g++ main.cpp -o badnes -std=c++11 -lSDL2main -lSDL2 -O3 +``` + +### Windows +```sh +git clone --recursive https://github.com/Ta180m/BadNES && cd BadNES +g++ main.cpp -o badnes -std=c++11 -IC:\mingw\include\SDL2 -LC:\mingw\lib -w -Wl,-subsystem,windows -lmingw32 -lSDL2main -lSDL2 -O3 +``` + ## FAQ ### Why the name? http://www.usaco.org/index.php?page=viewproblem2&cpid=1041 @@ -101,4 +105,4 @@ I'll say it's complete once I finish implementing the APU. Check to make sure BadNES implements its mapper. Also, Mapper 7 is known to be especially buggy. ## Credits -Special thanks to [Andrea Orru](https://github.com/AndreaOrru) for creating [LaiNES](https://github.com/AndreaOrru/LaiNES), the emulator that this project derives much of its code from.
\ No newline at end of file +Special thanks to [Andrea Orru](https://github.com/AndreaOrru) for creating [LaiNES](https://github.com/AndreaOrru/LaiNES), the emulator that this project derives much of its code from. |