Added simple instructions

1 files changed, 93 insertions, 0 deletions

diff --git a/INSTRUCTION b/INSTRUCTION
new file mode 100644
index 0000000..0c3b021
--- /dev/null
+++ b/INSTRUCTION
@@ -0,0 +1,93 @@
+                                    3dsspec
+                        Nintendo 3DS Spectrum emulator.
+
+             Copyright (C) 2021  Ian Cowburn <ianc@noddybox.co.uk>
+
+         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/>
+
+================================================================================
+
+1. General Operation
+--------------------
+
+You will be presented with the emulated spectrum screen in the upper display
+and a keyboard on the touch display.  Press the keys to interact with the
+emulation.  Click on the MENU banner to display the main menu.
+
+
+2. The Main Menu
+----------------
+
+The main menu shows the following options:
+
+    Reset Spectrum              - Reset the spectrum.
+    Load TAP File               - Load a TAP file from the SD card.  To load the
+                                  TAP file enter LOAD "" in the emulator.
+    Configure                   - Configures the emulator.  See the following
+                                  section.
+    Map Joypad to Keys          - Allows you to define what keys on the keyboard
+                                  the joypad and buttons will press.
+    Save Memory Snapshot        - Save a snapshot of the running state.
+    Load Memory Snapshot        - Load a previously saved memory snapshot.
+    Save Joypad/Key State       - Saves the current joypad to keys mapping.
+    Load Joypad/Key State       - Loads a saved joypad/key state.
+    Debug                       - Displays a debug menu.  See a later section
+                                  for details.
+    Exit 3DSSPEC                - Exits the emulator.
+    Cancel                      - Cancel the menu and go back to the emulation.
+
+
+3. Configuration
+----------------
+
+The configuration screen gives you the following options.
+
+    Sticky Shift                - Whether the two shift keys are 'sticky'.
+                                  Sticky means that when pressed the key stays
+                                  pressed until they are pressed again.
+    Load Default Snapshot       - Whether the emulator attempts to load a
+                                  memory snapshot called AUTO when it starts.
+    Sound                       - Whether to play sound.
+
+
+4. Debug Menu
+-------------
+
+The debug menu gives you access to various debug options.  The menu has the
+following options:
+
+    Enable Debug Output         - Enables debug output.  When selected it
+                                  prompts for a host and port number and
+                                  connects to that host and port to send debug
+                                  messages.
+    Disable Debug Output        - Disables the debug output.
+    Disassembler                - Displays a disassembly of the spectrum's
+                                  memory.  Press the joypad up/down to decrement
+                                  and increment the displayed address.  Press
+                                  the shoulder buttons to move in pages.  Press
+                                  the A button to enter an address.  Press the
+                                  START button to exit.
+    Memory Viewer               - Displays a hex dump of the spectrum's memory.
+                                  Press the joypad up/down to decrement and
+                                  increment the displayed address.  Press the
+                                  shoulder buttons to move in pages.  Press the
+                                  A button to enter an address.  Press the START
+                                  button to exit.
+    CPU Info                    - Displays a screen with the Z80's registers.
+                                  Press the shoulder buttons to cycle which
+                                  register pointer is dumped to the screen.
+                                  Press the A button to execute the next
+                                  instruction.  Hold the B button to execute
+                                  quickly.  Press the START button to exit.
+