starting to do doc cleanup

README.txt

@@ -1,6 +1,9 @@
-GSPLUS ALPHA
-============
+# GSPLUS
+An Apple IIgs emulator for Mac OSX, Windows, and Linux.
 
+![Screenshot of starting the program](doc/web/Screenshot.png "Screenshot of starting the program")
+
+# ABOUT
 This is an early release of an experimental project to modernize the
 KEGS/GSport emulator platform and eventually extend it.
 
@@ -10,13 +13,7 @@ and output (video, mouse, keyboard, audio, joystick).  The hope is that I can
 leverage the multi-platform nature of SDL to provide first-class support for
 the major plaforms supported by SDL, which includes Mac OSX, Windows and Linux.
 
-I'm not a huge fan of OSX, but I keep a MacBook Pro nearby for work, so the
-first version to be release is this OSX build.  I'll try to have builds for
-other platforms available in a few weeks.
-
-
-
-Some notes:
+# USAGE NOTES
 You need to provide the ROM file and disk images and a config file.  I'd
 recommend you just drop it in your current GSport or KEGS folder and run it
 from there.

doc/gsplusmanual.txt

@@ -1,19 +1,25 @@
-doc/gsplusmanual.pdfgsp_icon_512.png 
- 
-GSplus
-Modern cross-platform Apple IIgs emulator and tools based on KEGS & GSPort
-Manual Versions: 
-Beta Release: 2017-01-21
+GSplus gsp_icon_512.png 
+Modern cross-platform Apple IIgs emulator and tools,
+based on KEGS & GSPort
+
+________________
+ Screenshot.png Manual Revisions: 
+Beta Release: 2017-01-22
 Alpha Release: 2016-11-02
 Alpha Draft: 2016-10-27
 Initial Draft: 2016-05-01
+
+
+Downloads: 
+Latest downloads always available at https://apple2.gs/plus
+________________
 Overview & Purpose
-This project is an attempt to build a better Apple IIgs emulator by modernizing the KEGS/GSport emulator family and extending it into a platform. 
+This project is an attempt to build a better Apple IIgs emulator by modernizing the KEGS/GSport emulator family and extending it into a platform for gamers, enthusiasts and developers. 
 The first steps were a release of a new SDL2 driver.  SDL or "Simple DirectMedia Layer" enables the writing of one cross-platform driver to handle input and output (video, mouse, keyboard, audio, joystick).  This helps the goal of providing first-class support for all of the major platforms supported by SDL, including Mac OSX, Windows and Linux.
 Part of this effort has also led to the development of an automated build and packaging pipeline using Gitlab CI.  This helps our team of one continue to develop on primarily a single platform, while still ensuring that it works across many operating systems
-Currently, the main supported platforms are Linux, OSX and *Windows.  
+Currently, the main supported platforms are Linux, OSX and Windows.  
 Getting started
-1. Download the emulator package and put it in a folder
+1. Download the emulator package from https://apple2.gs/plus and put it in a folder
 2. Download the Apple IIgs Firmware ROMs, for either a ROM01 or ROM03 machine.
  (If you have a real IIgs, there are ways to save it from your machine too.)
 Try: ftp://ftp.apple.asimov.net/pub/apple_II/emulators/rom_images/
@@ -31,6 +37,13 @@ Try: ftp://ftp.apple.asimov.net/pub/apple_II/emulators/rom_images/
  Windows:                gsplus32.exe
  Mac/Ubuntu:        ./gsplus
 
+If the config file can’t be found, it will try to create a config.txt file for you, with all of the defaults.
+   1. Note: You can also specify a config file.  This is very useful as you can have specific disks/setting pre-set in a config file and launch directly into your favorite game with that config.  They can be named anything you want, though the officially recognized extensions are .txt and .gsp. 
+
+Examples:
+ Windows:                gsplus32.exe -config arkanoid.gsp
+ Mac/Ubuntu:        ./gsplus -config choplifter_config.txt
+
 
 ________________
 
@@ -50,16 +63,19 @@ Shift-F10         - toggle status line *
 Shift-F11         - toggle simulated scanlines *
 * not available on all platforms
 Other Input/Output
-   1. Mouse and keyboard should automatically work
-   2. Joystick with SDL2 driver is known to be working.  It simply uses the “first” joystick and the first analog pad on that stick plus the first two buttons.  The axes and buttons are not yet configurable.  Better info forthcoming.
-   3. There are drivers for serial controller, ImageWriter (II?) printer, and networking.  I may have broken some of this functionality to get builds working.  I’m not currently familiar with the state of these drivers or their usage.  More info will be added as I take time to research more of the modules. 
-   4. You can also drag-and-drop disk images onto the emulator window and it will try to automount the disk!  (SDL versions)
+      1. Mouse and keyboard should automatically work
+      2. Joystick with SDL2 driver is known to be working.  It simply uses the “first” joystick and the first analog pad on that stick plus the first two buttons.  The axes and buttons are not yet configurable.  Better info forthcoming.
+      3. There are drivers for serial controller, ImageWriter (II?) printer, and networking.  I may have broken some of this functionality to get builds working.  I’m not currently familiar with the state of these drivers or their usage.  More info will be added as I take time to research more of the modules. 
+      4. You can also drag-and-drop disk images onto the emulator window and it will try to automount the disk!  (SDL versions)
 Configuration Menu
 Configuration options are loaded from, and saved to, a configuration text file.  The default configuration file is config.txt.  If you are just starting out, it’s recommended to use the configuration menu versus editing the file yourself.
 Enter the configuration menu at any time while running GSplus by hitting <F4>.
  Screen Shot 2016-05-01 at 9.10.00 AM.png 
 
-Most importantly, you can use the Disk Configuration menu option to “mount” and “eject” disks.  There is also        
+Most important options are:
+Disk Configuration menu - options to “mount” and “eject” disks images
+ROM File Selection menu - if you don’t have it correctly pointing to a valid ROM 1 or ROM 3 image, it will not boot
+________________
 Command-line Options
 This is from source, some are experimental and not all may be built on your system.
 -badrd                        Halt on bad reads
@@ -133,10 +149,13 @@ v                        Show video information
 q                                       Exit Debugger (and GSplus)
 ________________
 Project Info
-Developers inquire within  :P
-Main page and full source code repository: https://github.com/digarok/gsplus
+Homepage and Downloads
 This project has a homepage at http://apple2.gs/plus/
 The homepage hosts the latest build for a variety of OSes. 
+
+
+Development Repository
+Main page and full source code repository: https://github.com/digarok/gsplus
   
 
 Release Changelog
@@ -156,4 +175,15 @@ First official alpha release with packages
 
 Version 0.11 - 2015 - 2016
 Not publicly released
-Features first major contribution - SDL2 driver supporting displays, sound and joysticks
+Features first major contribution - SDL2 driver supporting displays, sound and joysticks
+
+
+________________
+
+
+
+
+Credits & Thanks
+Thanks to Kent Dickey who originally wrote the open source KEGS, “Kent’s Emulated GS”
+Thanks to the GSPort developers which is the fork used to create GSplus. 
+Thanks to the other GSplus contributors, especially Kelvin Sherlock who has added quite a few of the latest features.