aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorIan C <ianc@noddybox.co.uk>2016-03-07 15:00:21 +0000
committerIan C <ianc@noddybox.co.uk>2016-03-07 15:00:21 +0000
commit77e8708934c5c792b1435fa11dfe3c0a6f636a8c (patch)
tree8c68ecddaf2c2c0730ba310b8d1b9e0f1bd16132 /README.md
parent6e9c9c9205d6eec1ff1cfb3fa407c6714854145a (diff)
Updated README and copied latest version in.
Diffstat (limited to 'README.md')
-rw-r--r--README.md39
1 files changed, 38 insertions, 1 deletions
diff --git a/README.md b/README.md
index 644a907..5b9b454 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,39 @@
# casm
-Cross assembler
+
+Portable cross assembler.
+
+## Usage
+
+Simply pass it the file to assemble, i.e.
+
+`casm source.txt`
+
+Full documentation can be found in either [PDF](docs/manual.pdf) or
+[HTML](docs/manual.html) format.
+
+## Processors
+
+Currently **casm** supports:
+
+ * Z80 (the default)
+ * 6502
+
+Plans for:
+
+ * Gameboy Z80 derarative
+ * Ricoh 5A22 (SNES)
+ * SPC700 (SNES sound chip)
+
+## Output Formats
+
+Currently **casm** supports:
+
+ * Raw binary output
+ * ZX Spectrum TAP file
+
+Plans for:
+
+ * D64 Commodore 1571 disk image
+ * T64 Commodore 64 tape image
+ * SNES ROM
+ * NES ROM