add documentation

This commit is contained in:
abbie 2022-02-15 21:27:28 +00:00
parent 69420a21c3
commit 1108291ad0
No known key found for this signature in database
GPG key ID: 04DDE463F9200F87
2 changed files with 20 additions and 0 deletions

11
README Normal file
View file

@ -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.

9
README.html Normal file
View file

@ -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>