add some docs

2 files changed, 64 insertions, 0 deletions

diff --git a/doc/TODO b/doc/TODO
new file mode 100644
index 0000000..be9ba42
--- /dev/null
+++ b/doc/TODO
@@ -0,0 +1,23 @@
+- port rs232.h code to new serial.h cc65 API, so we aren't stuck using
+  old versions of cc65.
+
+- port dasm stuff to ca65, so we only need one toolchain (the cc65 one).
+
+- tab-completion, by searching screen memory?
+
+- a bit of UTF-8 decoding. e.g. accented letters become 2 characters.
+  Spanish enya would be rendered as n, inverse ^ (since inverse ^ is
+  what we already use for the ~). Letter a with acute accent would
+  be "a" and "'", with grave accent the "'" is inverse. Degrees symbol
+  would be inverse lowercase o. Ellipses would just be 3 dots. Anything
+  we can't decode becomes inverse question mark. It would be really nice
+  to encode/decode the ATASCII graphics characters too.
+
+- support 'terminal server' devices, e.g. lantronix. These are devices
+  with an rs232 port + tcp/ip stack. Clients just talk rs232 and
+  the terminal server connects that to a remote host via TCP. Some
+  of these emulate modems (ATDT<ipaddress> for instance). Will require
+  some major surgery to split the SLIP stuff from the IRC protocol stuff.
+
+- support Dragon cart (or the other Ethernet cart, or the wireless one).
+  have to somehow get the hardware to test with first.
diff --git a/doc/ui.txt b/doc/ui.txt
new file mode 100644
index 0000000..efaab64
--- /dev/null
+++ b/doc/ui.txt
@@ -0,0 +1,41 @@
+The user interface is pretty sparse. Incoming IRC messages are printed,
+and your input line is marked by the regular Atari cursor. Text you
+enter is displayed in inverse video. If IRC messages are received while
+you're entering an input line, they're printed correctly without being
+intermixed with your input.
+
+The Atari character set lacks some commonly used ASCII characters. Most
+noticeable on IRC is the ~ (tilde). FujiChat prints an inverse-video ^
+(circumflex) instead. Also missing are { and } (curly braces). These
+are printed as inverse-video [ ] (square brackets). There is currently
+no way to type the ~ { } characters!
+
+Non-ASCII (Unicode/UTF-8) characters are not decoded. Generally these
+print as inverse capital B followed by another inverse video character
+(these are the raw UTF-8 encoded bytes).
+
+There are a few keyboard commands available. Normal Atari editing doesn't
+work (cursor keys, crtl-insert, etc). The maximum input length is 256
+characters: if you try to type more than that, the bell will ring,
+and further keystrokes (other than Enter or backspace) will be ignored.
+
+At the start of an empty line:
+
+  Control-N: shows list of users on the current channel (same as
+             the /names command).
+
+  Control-W: shows more detailed list of users on the current channel
+             (same as the /who command).
+
+  Tab: inserts "/msg user", where user is the last user you received
+       a private message from.
+
+In the middle of a line:
+
+  Shift-Delete or Control-U: delete the line you're typing.
+
+  Control-W: delete the last word you typed (back to and including
+             the last space, or to the start of the line if there's
+             no space).
+
+  Backspace: delete the last character typed, as usual.