diff --git a/.github/images/finder.png b/.github/images/finder.png new file mode 100644 index 0000000..c9e8f93 Binary files /dev/null and b/.github/images/finder.png differ diff --git a/README.md b/README.md index eaf4a6b..96f0717 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,24 @@ The Generic Tile Engine (GTE) project is a tile engine built to exploit the uniq Parallax scrolling of two full-screen static layers

+# Building from Source + +The library iscurrently implemented as a set of source files that must be compiled into a GS/OS application. A set of example project can be found under the `demos` folder. Each demo folder uses a `package.json` file to define the build targets and a build of each application can be created by executing a `npm run build` command. + +Each demo application has a top-level `App.s` that references the `src/Core.s` file which includes all of the GTE source +files into a separage OMF Segment. +## Dependencies + +GTE uses the [merlin32](https://brutaldeluxe.fr/products/crossdevtools/merlin/) assembler to compile its source into GS/OS OMF files and [Cadius](https://brutaldeluxe.fr/products/crossdevtools/cadius/index.html) to copy those files onto a ProDOS disk image. The paths to these tool can be set in the `package.json` file. + +An empty 2MG disk image is included in `emu/Target.2mg` and is used as the default location for copying demo applications. This image can be mounted in any IIgs emulator. + +

+
+ Build of demo app in the IIgs Finder +

+ + # Getting Started ## Initialization