Merge branch 'develop'

Author: robhagemans

.gitignore

@@ -2,6 +2,7 @@
 *.pyd
 *.pyo
 *.dll
+*.dylib
 .android.*
 USAGE.txt
 doc/

DEVELOPMENT.md

@@ -11,29 +11,36 @@ The instructions there cover the most common platforms and use cases.
 #### Dependencies ####
 The following packages are needed or recommended when installing PC-BASIC:
 
-| Package                                                                           | OS                 | Status       | Used for
-|-----------------------------------------------------------------------------------|--------------------|--------------|----------------------------------------
-| [Python 2.7.12](https://www.python.org/downloads/release/python-2712/)            | all                | required     |
-| [Setuptools](https://pypi.python.org/pypi/setuptools)                             | all                | required     |
-| [PySDL2](https://pysdl2.readthedocs.org/en/latest/)                               | all                | recommended  | sound and graphics
-| [NumPy](https://sourceforge.net/projects/numpy/files/)                            | all                | recommended  | sound and graphics
-| [PySerial 3.4](https://pypi.python.org/pypi/pyserial)                             | all                | optional     | physical or emulated serial port access
-| [PyParallel 0.2](https://sourceforge.net/projects/pyserial/files/pyparallel/0.2/) | Windows, Linux     | optional     | physical parallel port access
-| [PyGame 1.9.3](http://www.pygame.org)                                             | all                | optional     | sound and graphics (PyGame interface)
-| [PyAudio](http://people.csail.mit.edu/hubert/pyaudio/)                            | all                | experimental | sound (PortAudio engine)
+| Package                                                                       | OS                 | Status       | Used for
+|-------------------------------------------------------------------------------|--------------------|--------------|----------------------------------------
+| [Python 2.7.12](https://www.python.org/downloads/release/python-2712/)        | all                | required     |
+| [Setuptools](https://pypi.python.org/pypi/setuptools)                         | all                | required     |
+| [SDL2](https://www.libsdl.org/download-2.0.php)                               | all                | recommended  | sound and graphics
+| [NumPy](https://sourceforge.net/projects/numpy/files/)                        | all                | recommended  | sound and graphics
+| [PySerial 3.4](https://pypi.python.org/pypi/pyserial)                         | all                | optional     | physical or emulated serial port access
+| [PyParallel](https://sourceforge.net/projects/pyserial/files/pyparallel/0.2/) | Windows, Linux     | optional     | physical parallel port access
+| [PyGame 1.9.3](http://www.pygame.org)                                         | all                | optional     | sound and graphics (PyGame interface)
+| [PyAudio](http://people.csail.mit.edu/hubert/pyaudio/)                        | all                | experimental | sound (PortAudio engine)
 
 
 `setuptools` and `pip` are included with Python.
 Once you have a working Python installation, most dependencies can be installed with `pip`:
 
         pip install pysdl2 numpy pygame pyaudio pyserial
 
-If you require access to a physical parallel port,
-download PyParallel from the web site linked above. This is only supported on Windows and Linux.
-However, since most modern machines do not actually have parallel ports, you probably don't need it.
-PyParallel is _not_ needed for printing to a CUPS or Windows printer.
+To use the graphical interface, you will also need to install the [SDL2](https://www.libsdl.org/download-2.0.php) library.
+Install the library in your OS's standard location for libraries.
+If this causes difficulties, you can alternatively place the library in the following location:
 
-To use the graphical interface, you will also need to install the [`SDL2`](https://www.libsdl.org/download-2.0.php) library, which is _not_ included in the `pysdl2` package. Install the library in your OS's standard location. On Windows, you can alternatively place `sdl2.dll` in the `pcbasic\lib` directory.
+- Windows (64-bit Python, 64-bit SDL): `pcbasic\lib\win32_x64\sdl2.dll`  
+- Windows (32-bit Python, 32-bit SDL): `pcbasic\lib\win32_x86\sdl2.dll`  
+- MacOS: `pcbasic/lib/darwin/libSDL2.dylib`  
+
+[PyParallel](https://sourceforge.net/projects/pyserial/files/pyparallel/0.2/)
+is only needed to access physical parallel ports, not for printing to a CUPS or Windows printer.
+Note that most modern machines do not actually have parallel ports. If you have a parallel port and want to use it with PC-BASIC,
+download and install PyParallel from the link above. Although a `pyparallel` package exists in on PyPI, at present this does not work
+as essential libraries are missing.
 
 
 #### External tools ####
@@ -49,16 +56,21 @@ PC-BASIC employs the following external command-line tools, if available:
 
 
 #### Building from GitHub source repository ####
-The following additional packages are needed for development and testing:
-
-| Package                                                                                                        | OS      | Used for
-|----------------------------------------------------------------------------------------------------------------|---------|-----------------
-| [`git`](https://git-scm.com/)                                                                                  | all     | development
-| [Microsoft Visual C++ Compiler for Python 2.7](https://www.microsoft.com/en-us/download/details.aspx?id=44266) | Windows | development
-| [`lxml`](https://pypi.python.org/pypi/lxml/3.4.3)                                                              | all     | documentation
-| [`markdown`](https://pypi.python.org/pypi/Markdown)                                                            | all     | documentation
-| [`pylint`](https://pypi.python.org/pypi/pylint/1.7.6)                                                          | all     | testing
-| [`coverage`](https://pypi.python.org/pypi/coverage)                                                            | all     | testing
+The following additional packages are used for development, testing and packaging:
+
+| Package                                                                                                        | OS                | Used for
+|----------------------------------------------------------------------------------------------------------------|-------------------|-----------------
+| [Git](https://git-scm.com/)                                                                                    | all               | development
+| [Microsoft Visual C++ Compiler for Python 2.7](https://www.microsoft.com/en-us/download/details.aspx?id=44266) | Windows           | development
+| [`lxml`](https://pypi.python.org/pypi/lxml/3.4.3)                                                              | all               | documentation
+| [`markdown`](https://pypi.python.org/pypi/Markdown)                                                            | all               | documentation
+| [Prince](https://www.princexml.com/download/)                                                                  | all               | documentation
+| [`pylint`](https://pypi.python.org/pypi/pylint/1.7.6)                                                          | all               | testing
+| [`coverage`](https://pypi.python.org/pypi/coverage)                                                            | all               | testing
+| [`wheel`](https://pypi.python.org/pypi/wheel)                                                                  | all               | packaging
+| [`twine`](https://pypi.python.org/pypi/twine)                                                                  | all               | packaging
+| [`cx_Freeze`](https://pypi.org/project/cx_Freeze/)                                                             | Windows, MacOS    | packaging
+| [`fpm`](https://github.com/jordansissel/fpm)                                                                   | Linux             | packaging
 
 
 These are the steps to set up the local repository ready to run PC-BASIC:

README.md

@@ -18,28 +18,21 @@ See also the [PC-BASIC home page](http://robhagemans.github.io/pcbasic/).
 
 ### Quick Start Guide ###
 
-This quick start guide covers installation and elementary use of PC-BASIC. For more information, please refer to the [full PC-BASIC documentation](http://pc-basic.org/doc#) which covers usage, command-line options and a [comprehensive GW-BASIC language reference](http://pc-basic.org/doc#reference). This documentation is also included with the current PC-BASIC release.
+This quick start guide covers installation and elementary use of PC-BASIC. For more information, please refer to the [PC-BASIC documentation](http://pc-basic.org/doc/2.0#).
 
 If you find bugs, please [open an issue on GitHub](https://github.com/robhagemans/pcbasic/issues). It would be most helpful if you could include a short bit of BASIC code that triggers the bug.
 
 
 #### Installation ####
-The _stable release_ is preferred for desktop use. It can be downloaded from one of the following locations:  
 
-- [PC-BASIC releases on GitHub](https://github.com/robhagemans/pcbasic/releases)  
-- [PC-BASIC releases on SourceForge](https://sourceforge.net/projects/pcbasic/files/)  
+PC-BASIC desktop installers for Windows, Mac, and Linux can be downloaded from [GitHub](https://github.com/robhagemans/pcbasic/releases).
 
-Installers are provided in the form of a Windows `.exe` and a Mac OS `.dmg` which can be installed in the usual way for those platforms. For Linux and other Unix-based systems, a `.tgz` archive is provided which includes an install script. Please consult the documentation inside the package for further instructions.
-
-Python users can obtain _development releases_ from [PyPI](https://pypi.org/project/pcbasic/) through `pip install pcbasic`.
+Python users can obtain the PC-BASIC package from [PyPI](https://pypi.org/project/pcbasic/) through `pip install pcbasic`.
 
 
 #### BASIC survival kit ####
-Click on the PC-BASIC application icon or run `pcbasic` on the command prompt to start PC-BASIC. The default emulation target is
-GW-BASIC 3.23 on a generic IBM-compatible PC with a VGA video card.  
-
-PC-BASIC starts in direct mode, a 1980s-style interface operated by executing
-BASIC commands directly. There is no menu, nor are there any of the visual clues
+PC-BASIC has a 1980s-style interface operated by executing
+typed commands. There is no menu, nor are there any of the visual clues
 that we've come to expect of modern software.  
 
 A few essential commands to help you get around:  
@@ -54,7 +47,7 @@ A few essential commands to help you get around:
 | `SYSTEM`              | exits PC-BASIC immediately, discarding any unsaved program    |
 
 Use one of the key combinations `Ctrl+Break`, `Ctrl+Scroll Lock`, `Ctrl+C` or `F12+B`
-to interrupt a running program and return to direct mode.  
+to interrupt a running program.  
 
 
 #### Program location ####
@@ -65,7 +58,7 @@ If started through the start-menu shortcut, PC-BASIC looks for programs in the s
 
 If started from the command prompt, PC-BASIC looks for programs in the current working directory.
 
-See [the documentation on accessing your drives](http://pc-basic.org/doc#mounting) for more information.
+See [the documentation on accessing your drives](http://pc-basic.org/doc/2.0#mounting) for more information.
 
 
 #### External resources ####
@@ -75,7 +68,7 @@ The following pages have GW-BASIC program downloads, lots of information and fur
 - [PeatSoft](http://archive.is/AUm6G) provides GW-BASIC documentation, utilities and some more games.  
 - [Neil C. Obremski's gw-basic.com](http://www.gw-basic.com/) has some fun new games made recently in GW-BASIC.  
 - [Leon Peyre](http://peyre.x10.mx/GWBASIC/) has a nice collection of GW-BASIC programs, including the (in)famous first IBM PC game `DONKEY.BAS`.  
-- [Brooks deForest](http://www.brooksdeforest.com/tandy1000/) provides his amazing Tandy GW-BASIC games, all released into the public domain.  
+- [Brooks deForest](https://web.archive.org/web/20170222075609/brooksdeforest.com/tandy1000) provides his amazing Tandy GW-BASIC games, all released into the public domain.  
 - [TVDog's Archive](http://www.oldskool.org/guides/tvdog/) is a great source of information and GW-BASIC programs for the Tandy 1000.  
 - [Phillip Bigelow](http://www.scn.org/~bh162/basic_programs.html) provides scientific programs written in GW-BASIC.  
 - [Gary Peek](http://www.garypeek.com/basic/gwprograms.htm) provides miscellaneous GW-BASIC sources which he released into the public domain.  

THANKS.md

@@ -33,18 +33,19 @@ PC-BASIC incorporates code derived from other projects, in particular:
 
   * **J-L Morel**'s [Win32::Console::ANSI](http://search.cpan.org/~jlmorel/Win32-Console-ANSI-1.11/lib/Win32/Console/ANSI.pm)
   * **Valentin Lab**'s [win_subprocess.py](https://gist.github.com/vaab/2ad7051fc193167f15f85ef573e54eb9)
+  * **Marcus von Appen**'s [PySDL2](https://pysdl2.readthedocs.org/en/latest/)
 
 PC-BASIC depends on the following open-source projects:
 
   * [Python](http://www.python.org)
   * [Setuptools](https://pypi.python.org/pypi/setuptools)
+  * [NumPy](http://www.numpy.org)
+  * [PySerial](https://github.com/pyserial/pyserial)
+  * [PyParallel](https://github.com/pyserial/pyparallel)
   * [Simple DirectMedia Layer (SDL)](http://www.libsdl.org)
   * [SDL2_gfx](http://www.ferzkopp.net/wordpress/2016/01/02/sdl_gfx-sdl2_gfx/)
-  * [PySDL2](https://pysdl2.readthedocs.org/en/latest/)
   * [PyGame](http://www.pygame.org)
   * [PyAudio](http://people.csail.mit.edu/hubert/pyaudio/)
-  * [NumPy](http://www.numpy.org)
-  * [PySerial](http://pyserial.sourceforge.net/pyserial.html)
 
 
 ### Fond memories
@@ -153,17 +154,20 @@ Documentation tools:
 
   * [LXML](http://lxml.de)
   * [Markdown](https://pypi.python.org/pypi/Markdown)
+  * [Prince](https://www.princexml.com/download/)
 
 Packaging tools:
 
-  * [PyInstaller](http://www.pyinstaller.org)
-  * [Nullsoft Scriptable Install System](http://nsis.sourceforge.net)
-  * [7-Zip](http://www.7-zip.org)
+  * [Wheel](https://pypi.python.org/pypi/wheel)
+  * [Twine](https://pypi.python.org/pypi/twine)
+  * [cx_Freeze](https://anthony-tuininga.github.io/cx_Freeze/)
+  * [fpm](https://github.com/jordansissel/fpm)
 
 Source code and releases are hosted on:
 
   * [GitHub](https://github.com/)
   * [SourceForge](https://sourceforge.net/)
+  * [PyPI](https://pypi.org/project/pcbasic/)
 
 
 ### Emulators