Skip to content

Commit

Permalink
revise readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jiangyy committed Feb 12, 2014
1 parent 85ac410 commit e4ba2dc
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
## LiteNes
## LiteNES

This project is a fork of Stanislav Yaglo's mynes (https://github.com/yaglo/mynes).
We mainly refactored the project for brevity and portabilty,
by removing unused comments and changing the file structure.
LiteNes runs classical roms (e.g., Battle City, Yie-Ar Kung Fu and Super Mario),
LiteNES runs classical roms (e.g., Battle City, Yie-Ar Kung Fu and Super Mario),
but has only partial support of NES roms, and does not support the emulation of APU.

The key feature of LiteNes is its *portability*:
The key feature of LiteNES is its *portability*:
the system-call-dependent code is reduced to minimal
(only appears in `hal.c` and `main.c`).
All other sources *do not contain any direct or indirect calls to the operating system kernel*.
Also, the only calls to standard C library are memory movements (e.g., `memcpy` and `memcmp`).

### Compilation
To compile LiteNes, you must have *allegro5* library.
To compile LiteNES, you must have *allegro5* library.
Usually you can install it in the official software repository
(by `apt-get`, `yum`, `pacman` or `emerge`, depending on your Linux distribution).

Expand All @@ -22,10 +22,10 @@ the `litenes` binary file is created.

### Game Play
You need to prepare a NES rom first.
Assume it (`rom.nes`) is located in the same directory as the LiteNes binary.
Assume it (`rom.nes`) is located in the same directory as the LiteNES binary.
Then in this directory, type `./litenes rom.nes` to start the emulator.

Key bindings: UP - `W`, DOWN - `S`, LEFT - `A`, RIGHT - `D`, SELECT - `U`,
START - `I`, A - `K` and B - `J`. Only one player is supported.

![LiteNes running Yie-Ar Kung Fu](https://raw.github.com/NJUOS/litenes/kungfu.png)
![LiteNES running Yie-Ar Kung Fu](https://raw.github.com/NJUOS/litenes/master/kungfu.png)

0 comments on commit e4ba2dc

Please sign in to comment.