docs: add README.md
This commit is contained in:
parent
a67489af7e
commit
29720d051a
1 changed files with 22 additions and 0 deletions
22
README.md
Normal file
22
README.md
Normal file
|
|
@ -0,0 +1,22 @@
|
||||||
|
# c8
|
||||||
|
**c8** is a simple CHIP-8 emulator written in C for educational purposes. It emulates the original CHIP-8 virtual machine, allowing you to run CHIP-8 ROMs.
|
||||||
|
|
||||||
|
## What is CHIP-8?
|
||||||
|
CHIP-8 is a virtual machine designed in the 1970s to simplify game development on 8-bit systems. It features:
|
||||||
|
- 4K memory
|
||||||
|
- 16 8-bit general-purpose registers
|
||||||
|
- 64×32 monochrome display
|
||||||
|
- Hex-based keypad (16 keys)
|
||||||
|
- Stack, timers, and a simple instruction set
|
||||||
|
|
||||||
|
## Dependencies
|
||||||
|
**c8** depends on some libraries, those are:
|
||||||
|
- SDL2
|
||||||
|
- [libft](https://git.sourcedot.nl/zoeynoort/libft)
|
||||||
|
|
||||||
|
## Building c8
|
||||||
|
To build c8, run the following command,
|
||||||
|
```bash
|
||||||
|
make
|
||||||
|
```
|
||||||
|
This will compile the project and output the executable to bin/c8
|
||||||
Loading…
Add table
Add a link
Reference in a new issue