Skip to content

Commit a5b3dcf

Browse files
daniroddanirod
committed
Update README
1 parent 3b9c423 commit a5b3dcf

File tree

6 files changed

+77
-215
lines changed

6 files changed

+77
-215
lines changed

‎README‎

Lines changed: 40 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,47 @@
1-
This is my own implementation of a CHIP-8 emulator made using C and the SDL2
2-
multimedia library. At the moment it is able to emulate a standard CHIP-8
3-
machine implementing all the opcodes provided by the specification.
1+
chip8 is a CHIP-8 emulator developed in C using the SDL2 multimedia library. It
2+
emulates a standard CHIP-8 machine and implements all the opcodes that the
3+
specification provides.
44

55
To emulate a binary ROM just provide the file as an argument:
66

77
$ chip8 ~/roms/TETRIS.bin
88

9-
To emulate an hexadecimal ROM you can use the `--hex` flag. Hexadecimal ROMs
10-
are files that only contains ASCII characters representing hexadecimal code.
11-
The ROM is compiled to binary during start up and executed as usual.
12-
13-
Keyboard controls are designed to emulate the classic CHIP-8 controller. This
14-
is the mapping. On the left, the actual CHIP-8 keypad. On the right, the
15-
keys in emulator. It will be possible in future releases to change the keys.
16-
At the moment the only way for doing this is by manually patching the source
17-
code.
18-
19-
Keypad: Emulation:
20-
1 2 3 C 1 2 3 4
21-
4 5 6 D Q W E R
22-
7 8 9 E A S D F
23-
A 0 B F Z X C V
24-
25-
In the subdirectory 'examples' you may find a few public domain ROMs that
26-
can be emulated using this emulator as well as any other emulator you can
27-
find on the Internet.
28-
29-
See 'COPYING' for copying conditions.
30-
See 'INSTALL' for compilation and installation instructions.
31-
See 'NEWS' for a list of changes in latest releases.
32-
See 'ChangeLog' for a list of technical changes in the source code.
33-
See 'BUGS' for information on how to report bugs you may find.
34-
See 'AUTHORS' for the names of the maintainers of the source code.
35-
See 'THANKS' for a list of contributors and other helpful people.
9+
You can have more information by reading the software manual at the following
10+
locations:
3611

37-
In order to compile this project you will need to have SDL 2.0 headers and
38-
libraries in your machine. Head to www.libsdl.org to get those in case
39-
you still haven't got them or get them using your package manager if your
40-
operating system has any.
12+
* http://www.danirod.es/chip8/docs/current/manual/ (online manual).
13+
* http://www.danirod.es/chip8/docs/current/chip8.pdf (PDF manual).
4114

15+
In order to compile this project you will need to have SDL 2.0 headers and
16+
libraries in your machine. Head to www.libsdl.org to get those in case you
17+
still haven’t got them or get them using your package manager if your operating
18+
system has any.
19+
20+
After installing SDL 2.0 you can download the software distribution and install
21+
it via the following commands:
22+
23+
autoreconf --install # Only if you are using the Git repository
24+
./configure
25+
make
26+
make install
27+
make check # Optional: to test the emulator -- libcheck is required
28+
29+
This program is released under the terms of the GNU General Public License v3.
30+
See the COPYING file for the entire distribution conditions.
31+
32+
CHIP-8: A multiplatform CHIP-8 emulator done in SDL
33+
Copyright © 2015-2016 Dani Rodríguez <[email protected]>
34+
35+
This program is free software: you can redistribute it and/or modify
36+
it under the terms of the GNU General Public License as published by
37+
the Free Software Foundation, either version 3 of the License, or
38+
(at your option) any later version.
39+
40+
This program is distributed in the hope that it will be useful,
41+
but WITHOUT ANY WARRANTY; without even the implied warranty of
42+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
43+
GNU General Public License for more details.
44+
45+
You should have received a copy of the GNU General Public License
46+
along with this program. If not, see <http://www.gnu.org/licenses/>.
47+
See COPYING for the entire contents of the license.

‎README.md‎

Lines changed: 37 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
1-
[![Build Status](https://travis-ci.org/danirod/chip8.svg)](https://travis-ci.org/danirod/chip8)
2-
[![Coverage Status](https://coveralls.io/repos/github/danirod/chip8/badge.svg?branch=devel)](https://coveralls.io/github/danirod/chip8?branch=devel)
3-
[![GitHub tag](https://img.shields.io/github/tag/danirod/chip8.svg)](https://github.com/danirod/chip8/releases/latest)
4-
[![GitHub license](https://img.shields.io/badge/license-GPL3-blue.svg)](http://www.gnu.org/licenses/gpl-3.0.html)
1+
# CHIP-8 [![Build Status](https://travis-ci.org/danirod/chip8.svg)](https://travis-ci.org/danirod/chip8) [![Coverage Status](https://coveralls.io/repos/github/danirod/chip8/badge.svg?branch=devel)](https://coveralls.io/github/danirod/chip8?branch=devel) [![GitHub tag](https://img.shields.io/github/tag/danirod/chip8.svg)](https://github.com/danirod/chip8/releases/latest) [![GitHub license](https://img.shields.io/badge/license-GPL3-blue.svg)](http://www.gnu.org/licenses/gpl-3.0.html)
52

6-
# CHIP-8
7-
8-
This is my own implementation of a CHIP-8 emulator made using C and the SDL2
9-
multimedia library. At the moment it is able to emulate a standard CHIP-8
10-
machine implementing all the opcodes provided by the specification.
3+
chip8 is a CHIP-8 emulator developed in C using the SDL2 multimedia library. It emulates a standard CHIP-8 machine and implements all the opcodes that the specification provides.
114

125
## Usage
136

@@ -17,59 +10,56 @@ To emulate a binary ROM just provide the file as an argument:
1710
$ chip8 ~/roms/TETRIS.bin
1811
```
1912

20-
To emulate an hexadecimal ROM you can use the `--hex` flag. Hexadecimal ROMs
21-
are files that only contains ASCII characters representing hexadecimal code.
22-
The ROM is compiled to binary during start up and executed as usual.
13+
You can have more information by reading the [software manual](http://www.danirod.es/chip8/docs/current/manual/). [Download as PDF](http://www.danirod.es/chip8/docs/current/chip8.pdf).
2314

24-
Keyboard controls are designed to emulate the classic CHIP-8 controller. This
25-
is the mapping. On the left, the actual CHIP-8 keypad. On the right, the
26-
keys in emulator. It will be possible in future releases to change the keys.
27-
At the moment the only way for doing this is by manually patching the source
28-
code.
15+
## Building from sources
2916

17+
In order to compile this project you will need to have SDL 2.0 headers and
18+
libraries in your machine. Head to www.libsdl.org to get those in case
19+
you still haven't got them or get them using your package manager if your
20+
operating system has any.
21+
22+
After installing SDL 2.0 you can download the software distribution and install it via the following commands:
23+
24+
```sh
25+
autoreconf --install # Only if you are using the Git repository
26+
./configure
27+
make
28+
make install
29+
make check # Optional: to test the emulator -- libcheck is required
3030
```
31-
Keypad: Emulation:
32-
1 2 3 C 1 2 3 4
33-
4 5 6 D Q W E R
34-
7 8 9 E A S D F
35-
A 0 B F Z X C V
36-
```
31+
3732
## Screenshots
3833

3934
GNU/Linux:
4035

41-
![CHIP-8 Emulator on GNU/Linux](doc/linux.png)
42-
43-
MacOS X:
36+
![CHIP-8 Emulator on GNU/Linux](http://www.danirod.es/chip8/screenshots/linux.png)
4437

45-
![CHIP-8 Emulator on MacOS X](doc/mac.png)
38+
Apple® MacOS® X:
4639

40+
![CHIP-8 Emulator on MacOS X](http://www.danirod.es/chip8/screenshots/mac.png)
4741

48-
Windows:
4942

50-
![CHIP-8 Emulator on Windows](doc/windows.png)
43+
Microsoft® Windows®:
5144

52-
## Files
45+
![CHIP-8 Emulator on Windows](http://www.danirod.es/chip8/screenshots/windows.png)
5346

54-
In the subdirectory 'examples' you may find a few public domain ROMs that
55-
can be emulated using this emulator as well as any other emulator you can
56-
find on the Internet.
47+
## License
5748

58-
* See 'COPYING' for copying conditions.
59-
* See 'INSTALL' for compilation and installation instructions.
60-
* See 'NEWS' for a list of changes in latest releases.
61-
* See 'ChangeLog' for a list of technical changes in the source code.
62-
* See 'BUGS' for information on how to report bugs you may find.
63-
* See 'AUTHORS' for the names of the maintainers of the source code.
64-
* See 'THANKS' for a list of contributors and other helpful people.
49+
CHIP-8: A multiplatform CHIP-8 emulator done in SDL
50+
Copyright © 2015-2016 Dani Rodríguez <[email protected]>
6551

66-
## Dependencies
52+
This program is free software: you can redistribute it and/or modify
53+
it under the terms of the GNU General Public License as published by
54+
the Free Software Foundation, either version 3 of the License, or
55+
(at your option) any later version.
6756

68-
In order to compile this project you will need to have SDL 2.0 headers and
69-
libraries in your machine. Head to www.libsdl.org to get those in case
70-
you still haven't got them or get them using your package manager if your
71-
operating system has any.
57+
This program is distributed in the hope that it will be useful,
58+
but WITHOUT ANY WARRANTY; without even the implied warranty of
59+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
60+
GNU General Public License for more details.
7261

73-
## License
62+
You should have received a copy of the GNU General Public License
63+
along with this program. If not, see <http://www.gnu.org/licenses/>.
7464

75-
This project is available under a GNU General Public License v3 license. See COPYING for copying conditions.
65+
See COPYING for the entire contents of the license.

‎doc/linux.png‎

-6.88 KB
Binary file not shown.

‎doc/mac.png‎

-9.93 KB
Binary file not shown.

‎doc/schip8.txt‎

Lines changed: 0 additions & 134 deletions
This file was deleted.

‎doc/windows.png‎

-3.08 KB
Binary file not shown.

0 commit comments

Comments
 (0)