From c2e81f8972b6a0bb3c4dbf675edb9d9bae1c50e1 Mon Sep 17 00:00:00 2001
From: Thomas Voss <mail@thomasvoss.com>
Date: Sun, 18 Feb 2024 16:51:35 +0100
Subject: Update README

---
 README.md | 46 +++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 43 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 8677a49..d8bce96 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,46 @@
-# Ahoy — The CHIP-8 Emulator and -Toolchain
+# Ahoy! — The CHIP-8 Emulator and -Toolchain
 
 
-### Where does the name come from?
+Ahoy! (the ‘!’ is part of the name) is a CHIP-8 emulator and -toolchain.
+As of writing, the following binaries exist as part of the Ahoy!
+distribution:
 
-The ‘Chips Ahoy!’ cookies.
+- `ahoy` — GUI emulator
+- `c8asm` — CHIP-8 assembler
+- `c8dump` — CHIP-8 disassembler
+
+
+## Where does the name come from?
+
+The ‘Chips Ahoy!’ cookies I enjoyed as a child.
+
+
+## Building and Installation
+
+The entire project can be built with a C23 compiler:
+
+```sh
+$ cc -std=c23 -o make make.c
+$ ./make          # compile everything
+$ ./make install  # install everything
+```
+
+The following flags can be provided to the build script:
+
+- `-f` / `--force`: force a complete rebuild
+- `-r` / `--release`: build with optimizations enabled
+
+
+## Documentation
+
+All programs in the Ahoy! collection are documented via manual pages.
+You can read them either with the `man` command, or by passing the
+`-h`/`--help` flag to the given program.
+
+
+## Potential Future Plans?
+
+- TUI emulator via ncurses
+- Compiler for a C-like higher-level language
+- SCHIP support
+- Handheld emulator on an embedded system
-- 
cgit v1.2.3