a/BadNES
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases 5 Wiki Activity

Update README.md

Browse source
This commit is contained in:
Anthony Wang 2020-05-19 15:12:54 -05:00 committed by GitHub
parent afe538d6dd
commit f75f7eb618
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
README.md
View file

@ -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.
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.