docs: add README.md

This commit is contained in:
Zoëy Noort 2025-05-05 18:49:45 +02:00
parent a67489af7e
commit 29720d051a

22
README.md Normal file
View 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