Apple-2-Tools
/
install-cadius-action
mirror of https://github.com/digarok/install-cadius-action.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

update README.md

This commit is contained in:
Dagen Brock 2020-03-06 11:40:02 -06:00
parent 15604e6ca6
commit 1bdfbcd09b
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -19,7 +19,19 @@ A Github Action for installing Cadius and allowing you to manipulate ProDOS disk
# Arguments/Inputs
This action has one input: `include_prodos`. By setting this to true, it will download the latest release of ProDOS (2.4.2) and extract all of the files to a directory called `PRODOS.2.4.2`. This allows you to use those files, if needed, in subsequent steps. So you can create a bootable disk or even add `BASIC.SYSTEM` to launch into AppleSoft BASIC.
This action has one input: `include_prodos`. It defaults to true, it will download the latest release of ProDOS (2.4.2) and extract all of the files to a directory called `PRODOS.2.4.2`. This allows you to use those files, if needed, in subsequent steps. So you can create a bootable disk or even add `BASIC.SYSTEM` to launch into AppleSoft BASIC. If you don't need any of the ProDOS files, you can skip this by setting it to false and save a second or two.
# Usage Recommendations
1. While you can call Cadius directly from [`run`](https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsrun) commands as shown above, it makes sense to put your packaging command(s) in a script which can be run locally with the same results.
2. Cadius uses a specific file, `_FileInformation.txt` for inferring ProDOS filetype and access information. That is not covered here, see the [Cadius Documentation](http://brutaldeluxe.fr/products/crossdevtools/cadius/).
3. This action is intended to pair really well with my [`install-merlin32-action`](https://github.com/digarok/install-merlin32-action) which let's you assembled the 65xx source code to build your object/system files that can then packaged inside a ProDOS image file using this action for immediate use in your emulator or flash drive. I use this workflow to handle build and release all via Github Actions.
# About CADIUS
Cadius is a disk image program originally by the amazing French team, Brutal Deluxe. They are not involved with this Open Source version, but I do recommend you view [their site](http://brutaldeluxe.fr/products/crossdevtools/cadius/) for more information on Cadius and their other incredible tools and releases.
# Further Examples
For a fully-integrated pipeline, see my example Apple II project here (https://github.com/digarok/apple2-assembly-github-actions-ci-example).