summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authordweller <dweller@cabin.digital>2025-03-26 20:47:55 +0200
committerdweller <dweller@cabin.digital>2025-03-26 20:47:55 +0200
commit2bcb97cade32e4781135ff4c1500b95fcf351889 (patch)
treefcaeeca83e8a5e831ee3827414ba954c52a8db86 /README
parent750cd23d7afac165502defa1d259ace00ca0e414 (diff)
add LICENSE(s) + README
Diffstat (limited to 'README')
-rw-r--r--README25
1 files changed, 25 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..c31beb1
--- /dev/null
+++ b/README
@@ -0,0 +1,25 @@
+CHIP-8 Cross-Platform(in the future) Interpreter
+================================================
+
+## What?
+ See https://en.wikipedia.org/wiki/CHIP-8
+
+ Heavily Work In Progress. Do not use even for fun! Well unless you're making fun of
+ my code, then feel free to.
+
+## Why?
+ For fun and glory!
+
+## How?
+ C89 baby! + system libs in the future.
+
+## Build?
+ *nix:
+ $ CC=/your/compiler/cc ./build/x11
+
+## Run?
+ *nix:
+ $ ./artifacts/xip-8 [binary file containing CHIP-8 instructions]
+
+## Who?
+ Me! See LICENSE.