aboutsummaryrefslogtreecommitdiff
path: root/projects/chip8emu.md
diff options
context:
space:
mode:
authorRaghuram Subramani <raghus2247@gmail.com>2025-08-02 10:35:20 +0530
committerRaghuram Subramani <raghus2247@gmail.com>2025-08-02 10:35:20 +0530
commita23a1609de4c063a823671fb7079b7d2deb0675e (patch)
treed7578a323671e1f471ce69c041518976b6dfd5e5 /projects/chip8emu.md
parentd257acac369a77f892579166ba2bcfe1818e59ca (diff)
projects: hydrate pages with README and add page structure
Diffstat (limited to 'projects/chip8emu.md')
-rw-r--r--projects/chip8emu.md22
1 files changed, 21 insertions, 1 deletions
diff --git a/projects/chip8emu.md b/projects/chip8emu.md
index df2aaa5..ffe32f4 100644
--- a/projects/chip8emu.md
+++ b/projects/chip8emu.md
@@ -3,6 +3,26 @@ description = An Emulator/Interpreter for CHIP-8.
languages = C++
url = /projects/chip8emu
template = project.html
+link = https://github.com/compromyse/autograd
+linklabel = SOURCE
---
-# CHIP8Emu
+![image](https://github.com/compromyse/CHIP8Emu/assets/71056504/f87e9e73-f880-4d60-a61b-cdb40791211b)
+
+## About The Project
+
+CHIP8Emu is an emulator for the 1977 interpreter CHIP-8 written in C++. It aims to make games designed for the same playable on modern hardware.
+
+## Compilation & Usage
+
+For compilation, you need Clang, CMake, GNUMake, and SDL2. With them installed, run the following.
+```sh
+mkdir build; cd build
+cmake ..
+make
+```
+
+Replace `[scale]` with your preferred display scaling, `[delay]` with the your preferred delay, and `[ROM]` with the path to the game you intend to play.
+```sh
+./chip8emu [scale] [delay] [ROM]
+```