aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCeleste <colean@colean.cc>2022-02-15 21:27:28 +0000
committerCeleste <colean@colean.cc>2022-02-15 21:27:28 +0000
commit1108291ad0f8d567ae38e3ba2b5dcff9ce1fd0a0 (patch)
treededb9b7de8a525ae2f2c7469807b29d93abd515a
parent69420a21c3ad1f7f3c9256b163bd270d0ad9275a (diff)
add documentation
-rw-r--r--README11
-rw-r--r--README.html9
2 files changed, 20 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..8b82339
--- /dev/null
+++ b/README
@@ -0,0 +1,11 @@
+wdrce
+---------
+wdrce is an open-source, minimal emulator for the WDR paper computer.
+
+It fits in around 70 lines and is written in Rust with no run-time or build-time dependencies.
+
+Usage
+---------
+wdrce comes with a registers file with the source code. This is not required however is used to set the registers before the program is executed.
+
+Any file containing valid instructions can be read. Any invalid instructions are ignored. The emulated file is passed as a command-line argument.
diff --git a/README.html b/README.html
new file mode 100644
index 0000000..768ccde
--- /dev/null
+++ b/README.html
@@ -0,0 +1,9 @@
+<h2>wdrce</h2>
+<p>wdrce is an open-source, minimal emulator for the WDR paper computer.</p>
+
+<p>It fits in around 70 lines and is written in Rust with no run-time or build-time dependencies.</p>
+
+<h2>Usage</h2>
+<p>wdrce comes with a registers file with the source code. This is not required however is used to set the registers before the program is executed.</p>
+
+<p>Any file containing valid instructions can be read. Any invalid instructions are ignored. The emulated file is passed as a command-line argument.</p>