From a58886b19fce8438ff1fdca6ba296226fa6e46e4 Mon Sep 17 00:00:00 2001
From: David Schmenk <dschmenk@gmail.com>
Date: Wed, 31 Jan 2018 15:03:18 -0800
Subject: [PATCH] Add editor readme

---
 doc/Editor.md | 108 ++++++++++++++++++++++++++++++++++++++++++++++++++
 src/mkrel     |   1 +
 2 files changed, 109 insertions(+)
 create mode 100644 doc/Editor.md

diff --git a/doc/Editor.md b/doc/Editor.md
new file mode 100644
index 0000000..16d1994
--- /dev/null
+++ b/doc/Editor.md
@@ -0,0 +1,108 @@
+          WELCOME TO PLASMA!
+          ==================
+
+FIRST THINGS FIRST:
+TO NAVIGATE, USE THE ARROW KEYS.  ON THE
+APPLE ][:
+
+  CTRL-K = UP
+  CTRL-J = DOWN.
+
+TO JUMP AROUND THE TEXT FILE USE:
+
+  CTRL-W = JUMP UP
+  CTRL-Z = JUMP DOWN
+  CTRL-A = JUMP LEFT
+  CTRL-S = JUMP RIGHT
+
+  CTRL-Q = JUMP BEGINNING
+  CTRL-E = JUMP END
+
+THE 'ESCAPE' KEY WILL PUT YOU IN COMMAND
+MODE.  FROM THERE YOU CAN EXIT BY
+ENTERING 'Q' AND 'RETURN'. YOU CAN ALSO
+RETURN TO THE EDITOR BY JUST PRESSING
+'RETURN'.
+
+-------
+
+THE PLASMA EDITOR IS A SIMPLE TEXT
+EDITOR FOR ENTERING AND MANIPULATING
+TEXT AND SOURCE CODE FILES.  THE EDITOR
+ONLY SUPPORTS 40 COLUMN TEXT ALTHOUGH
+LINES CAN BE UP TO 79 CHARACTERS LONG.
+THE  SCREEN WILL SCROLL HORIZONTALLY
+AS THE CURSOR MOVES. THERE IS 16K OF
+MEMORY FOR THE TEXT BUFFER.
+
+IT HAS TWO MODES, COMMAND AND EDIT.
+
+  EDIT COMMANDS:
+
+    LEFT ARROW  = MOVE CHAR LEFT
+    RIGHT ARROW = MOVE CHAR RIGHT
+    UP ARROW    = MOVE LINE UP
+    DOWN ARROW  = MOVE LINE DOWN
+    CTRL-K      = MOVE LINE UP
+    CTRL-J      = MOVE LINE DOWN
+    CTRL-A      = JUMP LEFT
+    CTRL-S      = JUMP RIGHT
+    CTRL-W      = JUMP UP
+    CTRL-Z      = JUMP DOWN
+    CTRL-Q      = JUMP BEGIN
+    CTRL-E      = JUMP END
+    CTRL-D      = DELETE CHAR
+    CTRL-X      = DELETE LINE
+    CTRL-V      = COPY DELETED LINE
+    CTRL-O      = OPEN NEW LINE
+    CTRL-F      = OPEN A FOLLOWING NEW LINE
+    CTRL-T      = JOIN LINES
+    CTRL-I      = TOGGLE INSERT/OVERWRITE
+    ESCAPE      = SWITCH TO COMMAND MODE
+
+  APPLE ][ FEATURES:
+
+    SHIFT-M   = ]
+    CTRL-N    = [
+    CTRL-P    = _
+    CTRL-B    = |
+    CTRL-Y    = ~
+    CTRL-L    = SHIFT LOCK
+    SHIFT-LEFT ARROW = DELETE (SHIFT-MOD)
+
+    WITH THE SHIFT-KEY MOD ON AN
+    APPLE ][, UPPER AND LOWER CASE
+    ENTRY WORKS AS EXPECTED.
+
+    CTRL-C    = FORCE LOWER-CASE CHARS
+
+    IF YOU HAVE A LOWER-CASE CHARACTER
+    GENERATOR INSTALLED, YOU CAN FORCE
+    LOWER-CASE DISPLAY.  OTHERWISE,
+    UPPER CASE WILL BE DISPLAYED NORMALLY
+    BUT lower-case will be displayed in
+    inverse.  This is the default.
+
+  Apple //e AND //c FEATURES:
+
+    THE 'CLOSED-APPLE' KEY WILL MODIFY
+    THE ARROW KEYS INTO THEIR JUMP
+    EQUIVALENTS. IT WILL ALSO MODIFY
+    THE 'RETURN' KEY TO OPEN UP A LINE,
+    JUST LIKE CTRL-F.
+
+  COMMAND MODE:
+
+    <REQUIRED PARAMETER>
+    [OPTIONAL PARAMETER]
+
+    Q            = QUIT
+    R <FILENAME> = READ FILE
+    W [FILENAME] = WRITE FILE (OPTIONAL FILENAME)
+    A [FILENAME] = APPEND FILE
+    C [PREFIX]   = CATALOG FILES
+    P <PREFIX>   = SET PREFIX
+    H [SLOT]     = HARDCOPY TO DEVICE IN SLOT (DEFAULT 1)
+    N            = CLEAR TEXT IN MEMORY
+    E            = EDIT MODE
+    'RETURN'     = EDIT MODE
diff --git a/src/mkrel b/src/mkrel
index cc25938..a4064f4 100755
--- a/src/mkrel
+++ b/src/mkrel
@@ -1,6 +1,7 @@
 cp CMD#061000 prodos/CMD.BIN
 cp PLASMA.SYSTEM#FF2000 prodos/PLASMA.SYSTEM.SYS
 cp PLASMA16.SYSTEM#FF2000 prodos/PLASMA16.SYSTEM.SYS
+cp ../doc/Editor.md prodos/EDITOR.README.TXT
 
 rm -rf prodos/sys
 mkdir prodos/sys