From 29720d051a52b65a0e2143f41666517726d3bb20 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zo=C3=ABy=20Noort?= Date: Mon, 5 May 2025 18:49:45 +0200 Subject: [PATCH] docs: add README.md --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..a24bdd4 --- /dev/null +++ b/README.md @@ -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