Rewrite for new serial protocol

1 files changed, 27 insertions, 0 deletions

diff --git a/README.org b/README.org
new file mode 100644
index 0000000..7b439ef
--- /dev/null
+++ b/README.org
@@ -0,0 +1,27 @@
+#+title: zup
+
+zup is a CLI program for reading and writing from and to memory addresses of a
+computer running zbootloader. While designed for my Z80 based computer, one
+should be able to be adapt it to other platforms
+
+* Design goals
+- Stable communication: The serial port of my Z80 computer is known to have
+  some random bit flips. As such, my tools are designed with error correction.
+  Right now Hamming-(7,4) codes are used for each byte plus a crc16 checksum at
+  the end of each unit.
+- Speed: Error corrections were also needed to speed up communications
+  without fear of errors.
+
+* Dependencies
+- [ ] (optional) GNU Readline
+
+* Features yet to be implemented
+- [ ] ping
+- [ ] info
+- [ ] io_read and io_write
+
+* Wishlist
+- [ ] read intel hex files
+
+* Known bugs
+- [ ] write command can only handle up to ~8 byte sized packets