6502bench/SourceGen/Examples/README.md

# SourceGen Examples #

These are some sample projects you can play with.  The binaries are
accompanied by the original source code, so you can compare the SourceGen
project to the original.

 * Tutorial: simple projects, intended for use with the tutorial in
   the manual.
 * Scripts: extension script samples.
 * A2-lz4fh: two functions for unpacking a simplified form of LZ4 compression.
   One is 6502, the other is 65816.  This is pretty straightforward.
   [(Full project)](https://github.com/fadden/fhpack)
 * A2-Amper-fdraw: 6502 code that provides an Applesoft BASIC interface
   to a machine-language graphics library.  The public interface of the
   graphics library is defined in a .sym65 file.  This example has multiple
   entry points in a jump table, and is used to demonstrate address table
   formatting in the advanced tutorial.
   [(Full project)](https://github.com/fadden/fdraw)
 * A2-Zippy: a program for controlling an Apple IIgs CPU accelerator card.
   65816 sources, with a little bit of ProDOS 8 and IIgs toolbox usage.
   Demonstrates how extension scripts are used during analysis.
   [(Full project)](https://fadden.com/apple2/misc.html#zippy)
 * A2-HP-CDA: HardPressed Classic Desk Accessory.  This original binary is
   in 65816 code in OMF loader format, which was then prepared with
   SourceGen's OMF conversion tool.  (Try loading the "#b90100" file
   into the disassembler to see why.)
   [(Full project)](https://fadden.com/apple2/hardpressed.html)

You may be wondering why some of the example files have filenames with
things like "#061d60" in them.  It's a method of preserving the file type
for Apple II files used by some utilities.  The potential advantage for
disassembly is that the file type often determines the load address,
possibly removing some initial guesswork.
Initial file commit 2018-09-28 17:05:11 +00:00			`# SourceGen Examples #`

			`These are some sample projects you can play with. The binaries are`
			`accompanied by the original source code, so you can compare the SourceGen`
			`project to the original.`

Update A2-Zippy example The ZipChip GS register definitions can take advantage of the new I/O direction feature. Pulling them out into a .sym65 makes sense. 2019-10-19 17:10:26 +00:00			`* Tutorial: simple projects, intended for use with the tutorial in`
Initial file commit 2018-09-28 17:05:11 +00:00			`the manual.`
Add inline string script sample Also, updated LZ4FH sample, which needed to have explicit widths on a couple of zero-page pointers. Also, updated Zippy sample, which had a ton of unnecessary format entries for a couple of pointers. 2019-10-08 17:44:49 +00:00			`* Scripts: extension script samples.`
Initial file commit 2018-09-28 17:05:11 +00:00			`* A2-lz4fh: two functions for unpacking a simplified form of LZ4 compression.`
Update READMEs 2018-09-30 22:10:08 +00:00			`One is 6502, the other is 65816. This is pretty straightforward.`
Initial file commit 2018-09-28 17:05:11 +00:00			`[(Full project)](https://github.com/fadden/fhpack)`
			`* A2-Amper-fdraw: 6502 code that provides an Applesoft BASIC interface`
			`to a machine-language graphics library. The public interface of the`
Update READMEs 2018-09-30 22:10:08 +00:00			`graphics library is defined in a .sym65 file. This example has multiple`
Update A2-Zippy example The ZipChip GS register definitions can take advantage of the new I/O direction feature. Pulling them out into a .sym65 makes sense. 2019-10-19 17:10:26 +00:00			`entry points in a jump table, and is used to demonstrate address table`
			`formatting in the advanced tutorial.`
Initial file commit 2018-09-28 17:05:11 +00:00			`[(Full project)](https://github.com/fadden/fdraw)`
			`* A2-Zippy: a program for controlling an Apple IIgs CPU accelerator card.`
			`65816 sources, with a little bit of ProDOS 8 and IIgs toolbox usage.`
Update READMEs 2018-09-30 22:10:08 +00:00			`Demonstrates how extension scripts are used during analysis.`
Initial file commit 2018-09-28 17:05:11 +00:00			`[(Full project)](https://fadden.com/apple2/misc.html#zippy)`
Update A2-HP-CDA example This used to be an example of why disassembling Apple IIgs OMF binaries didn't work. Now it's an example of how well it works. 2020-07-11 04:22:18 +00:00			`* A2-HP-CDA: HardPressed Classic Desk Accessory. This original binary is`
			`in 65816 code in OMF loader format, which was then prepared with`
			`SourceGen's OMF conversion tool. (Try loading the "#b90100" file`
			`into the disassembler to see why.)`
Update READMEs 2018-09-30 22:10:08 +00:00			`[(Full project)](https://fadden.com/apple2/hardpressed.html)`
Initial file commit 2018-09-28 17:05:11 +00:00
Update A2-HP-CDA example This used to be an example of why disassembling Apple IIgs OMF binaries didn't work. Now it's an example of how well it works. 2020-07-11 04:22:18 +00:00			`You may be wondering why some of the example files have filenames with`
Initial file commit 2018-09-28 17:05:11 +00:00			`things like "#061d60" in them. It's a method of preserving the file type`
Update READMEs 2018-09-30 22:10:08 +00:00			`for Apple II files used by some utilities. The potential advantage for`
			`disassembly is that the file type often determines the load address,`
Update A2-HP-CDA example This used to be an example of why disassembling Apple IIgs OMF binaries didn't work. Now it's an example of how well it works. 2020-07-11 04:22:18 +00:00			`possibly removing some initial guesswork.`