added open-source-spin-compiler, spinloader and more documentation

README.md

@@ -1,62 +1,67 @@
-Parallax Toolchain Installer Script for Linux
+Parallax Tool-chain Installer Script for Linux
 =============================================
 
 (c) 2012 Stefan Wendler
 sw@kaltpost.de
 http://gpio.kaltpost.de/
 
+
 Introduction
 ------------
 
-Simple shell script to install Parallax-Propeller toolchain, including the BST tools and the Propeller GCC. 
+Simple shell script to install Parallax-Propeller tool-chain, including:
 
-The script will first try to download and install the The multi-platform Propeller Tool Suite including:
+* BST tools (compiler, PropBasic, loader, IDE + Propeller TTF)
+* Propeller GCC 
+* open-source-spin-compiler
+* Python based spin-loader from the propeller forums (Loader.py)
 
-* bst - The GUI IDE
-* bstc - The command line compiler
-* bstl - The command line loader
-* PropBASIC - The Propeller BASIC
 
 For more information on the BST tools see this the [BST homepage] (http://www.fnarfbargle.com/bst.html)
 
-Next, it will clone the Propeller GCC sources.
-
 For more information on porp GCC see the [propgcc homepage] (http://code.google.com/p/propgcc/)
 
+For more information on the open-source-spin-compiler see the [project page] (http://code.google.com/p/open-source-spin-compiler/)
+
+The Python based loader is from Remy Blank and I was not able to find a webpage for that tool.
+
 
 Non Intel Build Hosts
 ---------------------
 
-Using this scripts on a non intel build host does only work patially. This is because the
-propeller-loader tool releays on the bstc.linux binary which is a intel binary. At the moment
-the loader fails to build, no poropeller-gdb will be build since it relais on the loader library.
-However, on a ARM machine you will end up with a working propeller-gcc including wirkin C-libraries
+Using this scripts on a non Intel build host does only work partially. This is because the
+propeller-loader tool relays on the bstc.Linux binary which is a Intel binary. At the moment
+the loader fails to build, no propeller-gdb will be build since it relays on the loader library.
+However, on a ARM machine you will end up with a working propeller-gcc including working C-libraries
 and binutils, but you will not get the loader nor gdb. 
 
-However, it is possible to copy the SPIN binaries genarated on a intel platform to the non 
-intel build host, and make propeller-loader and gdb compile. If you like to try that, you
+However, it is possible to copy the SPIN binaries generated on a Intel platform to the non 
+Intel build host, and make propeller-loader and gdb compile. If you like to try that, you
 could enable "USE_LOADER_HACK" in the "config.inc" file.
 
+
 Requirements
 ------------
 
-* A working GCC environment on the host system you are building is required.
-* Mercurial needs to be installed.
-* Internet conenction is required.
+* A working GCC environment on the host system you are building is required for gcc.
+* Mercurial needs to be installed to build gcc.
+* Internet connection is required.
+* For the python based loader, python2.6 with py-serial is required
+* SVN is required to build the open-source-spin-compiler.
 
 
 Usage
 -----
 
 For various user setting see "config.inc".
 
-To build and install the whole toolchain:
+To build and install the whole tool-chain:
 
 	./install-propeller-toolchain.sh
 
 NOTE: the script may ask you for your root password to make the install dir with "sudo".
 
-After the script installed everything, you might want to add "/opt/parallax/bin" to yout path.
+After the script installed everything, you might want to add "/opt/parallax/bin" to your path.
 
 To clean up all temporary stuff:
 
@@ -66,23 +71,59 @@ To clean up all temporary stuff:
 Check the Result
 ----------------
 
-** Check Propeller GCC
+*Check Propeller GCC*
 
-Change to the gcctest subdirectory containing a simple "hello-world" which blinks all the build in LEDs of the 
-Parallax QuickStart board and prints out some message through the serial line and build the sources:
+Change to the "gcctest" subdirectory containing a simple "hello-world" which blinks all the build in 
+LEDs of the Parallax Quick-Start board and prints out some message through the serial line and build 
+the sources:
 
 	cd ./gcctest
 	export PATH=/opt/parallax/bin:$PATH
 	make
 
-This should produce a "main.elf" binary. Load this to the propeller:
+This should produce a "main.elf" binary. Load this to the propeller with:
+
+	make load
+
+
+*Check open-source-spin-compiler and spin-loader*
+
+Change to "spintest/osspin" subdirectory containing a simple SPIN program which blinks the LED on 
+P16:
+
+	cd ./spintest/osspin
+	export PATH=/opt/parallax/bin:$PATH
+	make
+
+This should produce a "blinky.binary" binary. Load this to the propeller with:
+
+	make load
+
+
+*Check BST Spin Command-line*
+
+Change to "spintest/bstspin" subdirectory containing a simple SPIN program which blinks the LED on 
+P16:
+
+	cd ./spintest/bstspin
+	export PATH=/opt/parallax/bin:$PATH
+	make
+
+This should produce a "blinky.binary" binary. Load this to the propeller with:
 
 	make load
 
-Enjoy!
 
+*Check BST Spin GUI*
+
+The above SPIN code (blinky.spin) could also be compiled and uploaded to the propeller through
+the GUI. To start the GUI:
+
+	bst
 
-** BST Spin
+Then, in the file-explorer on the left navigate to the sample code and open it. Then go to 
+compile, to compile and upload your program.  
 
-TODO
+Note: in the editor, check if the font looks "right" otherwise something went wrong
+withe the installation of the Propeller TTF-font.
 

config.inc

@@ -10,6 +10,12 @@ NUM_OF_PARMAKE=2
 # install the BST tools
 INSTALL_BST=1
 
+# install the open-source spin compiler 
+INSTALL_OSSPIN=1
+
+# install the python based spin loader 
+INSTALL_SPINLOADER=1
+
 # install propeller gcc
 INSTALL_GCC=1
 
@@ -24,3 +30,23 @@ JBUILD_OPTS="$NUM_OF_PARMAKE"
 # use the porpeller-loader hack (only needed for NON-Intel machines)
 ##
 USE_LOADER_HACK=1
+
+##
+# X11 customfont install location for BST
+##
+FONT_DIR=/usr/share/fonts/truetype/parallax
+
+##
+# BST tools source URLs
+##
+URL_BSTC=http://www.fnarfbargle.com/bst/bstc/Latest/bstc-0.15.3.linux.zip
+URL_BSTL=http://www.fnarfbargle.com/bst/bstl/Latest/bstl.linux.zip
+URL_BST=http://www.fnarfbargle.com/bst/Latest/bst-0.19.3.linux.zip
+URL_PROPBAS=http://www.fnarfbargle.com/PropBasic/PropBasic-bst-00.01.14-79.linux.zip
+URL_FONT=http://forums.parallax.com/attachment.php?attachmentid=53903&d=1212437073
+
+##
+# URL for mercurial repo of propgcc
+##
+URL_HG_PROPGCC=https://code.google.com/p/propgcc/
+