Initial documentation to record ideas regarding the keyboard.

1 files changed, 44 insertions, 0 deletions

diff --git a/doc/instruction.txt b/doc/instruction.txt
new file mode 100644
index 0000000..3e80aea
--- /dev/null
+++ b/doc/instruction.txt
@@ -0,0 +1,44 @@
+		      czx81 - A CURSES based ZX81 emulator
+			 Copyright (C) 2020 Ian Cowburn
+
+KEYBOARD
+--------
+
+All normal characters should produce the equivalent character if it exists
+on the ZX81.  The emulator assumes you can generate the characters A-Z which
+will be mapped to the equivalent ZX81 key when a lower case character is
+entered.  An upper case character will generate the shifted version of the
+character as it appeared on the ZX81 keyboard.
+
+The cursor keys should act as cursor keys.
+
+The ESCAPE key will display the runtime menu.
+
+The following keys have the following effects:
+
+F1		- Emulate the EDIT key (shift 1)
+F2		- Emulate the AND key (shift 2)
+F3		- Emulate the THEN key (shift 3)
+F4		- Emulate the TO key (shift 4)
+F5		- Emulate the GRAPHICS key (shift 9)
+F6		- Emulate the FUNCTION key (shift new line)
+F7		- Emulate the BREAK key (shift space)
+BACKSPACE	- Emulate the RUBOUT key (shift 0)
+DELETE		- Emulate the RUBOUT key (shift 0)
+
+
+LICENSE
+-------
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.