Final commit for v3.0

README.md

@@ -18,13 +18,15 @@ Features of this build environment include:
    * If you change a macro file used by one or more assembly source files, the right files will be re-assembled automatically.  Assembly file dependencies are generated during the build.
    * Supports project types like ORCA or GNO shell executable, GUI executable, new desk accessory, classic desk accessory and control panel.  In Xcode, when you create a project, you will see options for each of these project types.  Select one and you will have a skeleton project which includes enough code to give you a basic "hello world" style application of that type.
    * For shell targets, when you build and run, the shell command is executed right in Xcode itself using Golden Gate.  You can edit your run scheme configuration in Xcode to customize the arguments passed to your shell command.
-   * Creates a bootable disk image with your executable as part of the build for non-shell targets.  If your target is a CDA, NDA or CDev, the executable is copied to the appropriate place in the System folder.  For a desktop application, the executable is in the root of the bootable disk image.
-   * Automatically launches an Apple //gs emulator when you select build and run so you can go from coding to testing your latest build as quickly as possible.
+   * Creates a bootable disk image from a template as part of the build for non-shell targets.  If your target is a CDA, NDA or CDev, the executable is copied to the appropriate place in the System folder.
+   * Creates a distribution disk image with your build products on it.  Also, it creates a ShrinkIt archive of your distribution as part of the build.
+   * Automatically launches an Apple //gs emulator when you select build and run so you can go from coding to testing your latest build as quickly as possible.  GSPort, GSPlus and mame are the supported emulators.  It boots to the bootable disk image created and the distribution disk image is open in the Finder when the emulatoed machine boots.
+   * Write documenation for your project in markdown in Xcode and commit the markdown files into git.  At build time, these markdown files can be optionally converted to a Teach text file format and copied into your distribution.  That way, you can write your documentation in a form that is easy to manage on the "modern" side and have that converted to something usable on a GS.
    * C source and header files (including ORCA system includes) are indexed by Xcode.  By doing this, code completion and other features of Xcode should work.  That means, if you are coding in C and type "NewW", Xcode will suggest the toolbox calls NewWindow() and NewWindow2().  Select the one you want and Xcode fills it in, including the arguments that the toolbox call expects.
    * There is an optional code generation phase in the build.  If you want to write some scripts which generate C source files, C header files or assembly files which are then compiled/assembled in later phases of the build, this would let you do exactly that.
    * You can copy a directory of files onto the disk image beyond just the executable.  This is useful if you have other files you need to generate and/or distribute in your project.
    * Syntax highlighting and better editor support for ORCA/M assembly, Merlin assembly and resource files.  Keywords are completed and highlighted.  Indentation between start/end and data/end tokens for assembly and inside braces for resource files should be automatic.
-   * Errors returned by the C compiler, the resource compiler and the Merlin assembler are now understood by Xcode.  The error will be visible in the editor itself and Xcode will jump to the line reported by the compiler to contain the error.  Note that ORCA/M errors are not understood by Xcode at this time.
+   * Errors returned by the ORCA/C compiler, the ORCA/M assembler, the resource compiler and the Merlin assembler are now understood by Xcode.  The error will be visible in the editor itself and Xcode will jump to the line reported by the compiler to contain the error.
 
 
 MacOS  Versions:
@@ -44,8 +46,8 @@ In order to use this infrastructure from macOS, follow these instructions:
    3. You also need [Golden Gate](https://juiced.gs/store/golden-gate/) which is also available for a reasonable price from the Juiced.GS store.  Golden Gate allows the Orca tools to execute from a modern Mac (or Windows and Linux system also).  Follow the installation instructions for Golden Gate.
    4. Install [FUSE for macOS](https://osxfuse.github.io).  FUSE is required for ProFuse which you will install next.
    5. Install ProFUSE.  It is distributed with Golden Gate.  When you purchase Golden Gate, you should be given access to a GitLab repository.  Among the projects there is ProFUSE which allows your Mac to mount ProDOS volumes.  This is used by the build environment to create the bootable disk images.
-   5. Install the [Apple IIgs project template](https://github.com/jeremysrand/Apple2GSBuildPipeline/releases/download/2.0.3/Apple2GSXcodeTemplate.pkg).  Note that the next time you launch Xcode, you will be asked whether to load the OrcaM.ideplugin.  This is part of the project template and will provide better syntax highlighting for assembly and resource files.  Select the "Load Bundle" option in the dialog that Xcode shows you.
-   6. Install and setup the [GSPlus](https://apple2.gs/plus/) emulator or the [GSPort](http://gsport.sourceforge.net) emulator.  Either should work.  No matter which you choose, make sure you put a copy of your Apple //gs' ROM into a file called ~/Library/GSPort/ROM (where ~ represents your user's home directory).  Unfortunately, the Finder by default hides the Library folder from you so the easiest way to accomplish this is probably from the Terminal.
+   5. Install the [Apple IIgs project template](https://github.com/jeremysrand/Apple2GSBuildPipeline/releases/download/3.0/Apple2GSXcodeTemplate.pkg).  Note that the next time you launch Xcode, you will be asked whether to load the OrcaM.ideplugin.  This is part of the project template and will provide better syntax highlighting for assembly and resource files.  Select the "Load Bundle" option in the dialog that Xcode shows you.
+   6. Install and setup the [GSPlus](https://apple2.gs/plus/) emulator, the [GSPort](http://gsport.sourceforge.net) emulator and or the mame emulator which is easiest to install using [Ample](https://github.com/ksherlock/ample).  Each emulator should work.  No matter which you choose, make sure you put a copy of your Apple //gs' ROM into a file called ~/Library/GSPort/ROM (where ~ represents your user's home directory).  Unfortunately, the Finder by default hides the Library folder from you so the easiest way to accomplish this is probably from the Terminal.
    7. If you plan to use Merlin32 based projects, install the [Merlin32 binaries and libraries](https://www.brutaldeluxe.fr/products/crossdevtools/merlin/). By default, the build system assumes you have installed the Merlin32 binary in /usr/local/bin and put the library macro files in /usr/local/lib/Merlin. If you installed them somewhere else, you can override these location in your projects.  Note that in the distribution, the macro files in the library had CR/LF line endings and did not work until I converted them to have LF line endings.
 
 
@@ -87,7 +89,6 @@ Possible Future Improvements:
 
    * Support Hypercard XCMDs and Hyperstudio new button action project templates
    * Support Finder Extra project templates
-   * Improve the assembly project templates to be for feature rich and handle errors better.
    * Support other ORCA languages like Pascal, Modula-2 or Basic.
    * Allow multiple resource files and concatenate the resources together into the final executable.
 

pkg/createPackage

@@ -63,7 +63,7 @@ done < $PROJECTS
 
 rm -f $PROJECTS
 
-pkgbuild --root $TMPDIR --version 2.0.3 --identifier com.halcyontouch.Apple2gsTemplate.pkg --install-location /Library/Developer/Xcode/ --scripts pkg/scripts/ Apple2GSXcodeTemplate.pkg
+pkgbuild --root $TMPDIR --version 3.0 --identifier com.halcyontouch.Apple2gsTemplate.pkg --install-location /Library/Developer/Xcode/ --scripts pkg/scripts/ Apple2GSXcodeTemplate.pkg
 productbuild --distribution pkg/Distribution.xml --resource ./pkg temp.pkg
 rm Apple2GSXcodeTemplate.pkg
 productsign --sign "Developer ID Installer" temp.pkg Apple2GSXcodeTemplate.pkg