Skip to content

Commit

Permalink
Update README to match recent changes
Browse files Browse the repository at this point in the history
  • Loading branch information
jbqueru committed Dec 9, 2024
1 parent 8c145e8 commit 48fb7b3
Showing 1 changed file with 10 additions and 14 deletions.
24 changes: 10 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,23 +37,27 @@ if you extract non-code assets from the demo or its source tree,
and an `AGPL_DETAILS.md` file to explain the original author's
intentions for compliance with the AGPL license.

The demo itself is provided under 4 forms in the package:
The demo itself is provided under 5 forms in the package:
* A naked `STEPBACK.PRG` file meant to be executed e.g. from with
an emulator with GEMDOS hard drive emulation.
* A `stepback.msa` floppy image.
* A `stepback.st` uncompressed floppy image.
* A `stepback.msa` compressed floppy image.
* A copy of the source tree `src.zip` that was used to compile
the demo.
* The full source history as a git bundle `stepback.bundle` which
can be cloned with `git clone stepback.bundle`.

# Building

The build process expects to have rmac, cc, git and zip in the path.
The build process expects to have
rmac, cc, upx, hmsa, git and zip in the path.
Rmac can be found on [the official rmac web site](https://rmac.is-slick.com/).
UPX is [the Ultimate Packer for eXecutables](https://upx.github.io/).
Hmsa is part of [the Hatari emulator](http://hatari.tuxfamily.org/).

A basic build can be done in a single script `build.sh` which is
useful during most incremental development. However, a full
build from start to finish requires some manual steps:
A regular build can be done in a single script `build.sh` which is
useful during most incremental development. However, using the music
from the editable file requires some manual steps:

## Converting the music

Expand All @@ -76,14 +80,6 @@ into the source tree. `AREGDUMP.BIN` is provided in the source
tree already such that it's possible to modify the demo without
having to build and execute `ACONVERT.PRG`

## Packaging the floppy image

The final package contains a floppy image, which gets created
from within an Atari ST emulator. After running `build.sh`, run
an emulator with `out/stepback/stepback.msa` mounted as a floppy and
`out/tos/STEPBACK.PRG` available on an emulated hard disk, and
copy that file onto the floppy. Once that's done, run `makedist.sh`.

# (Un)important things

## Licensing
Expand Down

0 comments on commit 48fb7b3

Please sign in to comment.