Create installation

Scott Duensing 2019-08-10 19:55:02 -05:00
parent cd290acbc4
commit bb06c1c59c

27
Installation.md Normal file

@ -0,0 +1,27 @@
To install JoeyLib, you will need the following:
* For all targets:
* A Debian-flavored 64 bit Linux Machine
* For building JoeyLib for the Apple IIgs:
* ISO of [Opus II: The Software](https://juiced.gs/store/opus-ii-software/)
* MSI from and GIT access to [Golden Gate](https://juiced.gs/store/golden-gate/)
From a shell prompt on your Linux system, enter:
```shell
mkdir joey
cd joey
wget https://skunkworks.kangaroopunch.com/skunkworks/joeylib/raw/master/scripts/installer.sh
chmod +x installer.sh
./installer.sh
```
The installer will prepare your system and then present a menu of platforms on which you can build JoeyLib. The following items will be created in the same folder as *installer.sh*:
* *installWork/* - Temporary folder containing intermediate files
* *dist/* - Final JoeyLib binaries, header files, and helper scripts
* *sdks/* - Various tools needed to work with some of the supported platforms
* *joeylib/* - The source code to JoeyLib itself
* *joeyDev.sh* - A script to run to set up your system environment to use JoeyLib
If you are low on space, you can delete *installWork/* once you have built all the desired JoeyLib platforms. However, re-running the installer to update or modify your JoeyLib binaries will re-download and re-create much of what is stored there.