aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRaghuram Subramani <raghus2247@gmail.com>2024-10-07 17:46:21 +0530
committerGitHub <noreply@github.com>2024-10-07 17:46:21 +0530
commit381ec29ea6d33f5c38d6c77a6ff0aa6718d7e620 (patch)
treea0a5f2ff22eb8995547f2ba12f4e518ed08e1164
parent5a60f2b7a9b8dc811ac41237256bed759c68edb6 (diff)
Update README.mdHEADmain
-rw-r--r--README.md17
1 files changed, 7 insertions, 10 deletions
diff --git a/README.md b/README.md
index 2ab400c..2b932a0 100644
--- a/README.md
+++ b/README.md
@@ -1,27 +1,24 @@
# CHIP8Emu
-An emulator for CHIP-8 written in C++
![image](https://github.com/compromyse/CHIP8Emu/assets/71056504/f87e9e73-f880-4d60-a61b-cdb40791211b)
-## Building
+## About The Project
-### Requirements
+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.
-* CMake
-* SDL2
-* Make
-
-### Running the build
+## Compilation & Usage
+For compilation, you need Clang, CMake, GNUMake, and SDL2. With them installed, run the following.
```sh
mkdir build; cd build
cmake ..
make
```
-## Syntax
+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>
+./chip8emu [scale] [delay] [ROM]
```
+<br>
# Thanks!