diff --git a/tools/st/README.md b/tools/st/README.md index 4278408..683d5d3 100644 --- a/tools/st/README.md +++ b/tools/st/README.md @@ -23,35 +23,66 @@ Commands: help Displays help information about the specified command ``` -## Sub-command help +## Sub-command extract ```shell $ st extract --help -Usage: st extract [-h] [--skip-empty] [--stdin] [--stdout] - [--border=] [--format=] - [--shape=] [-o=] [-w=] - [] +Usage: st extract [-hO] [--skip-empty] [--stdin] [--stdout] + [--border=] [--coding=] + [--format=] [-o=] [-w=] + [--shapes=]... [] Extract shapes from shape table Parameters: - [] File to process + [] File to process Options: - --border= - Set border style (none, simple, box) - Default: simple + --border= Set border style (none, simple, box) + Default: simple + --coding= Select source style (bitmap, long, short) + Default: long --format= - Select output format (text, png, gif, jpeg, bmp, wbmp) - Default: text - --shape= Extract specific shape - --skip-empty Skip empty shapes - --stdin Read from stdin - --stdout Write to stdout - -h, --help Show help for subcommand - -o, --output= - Write output to file - -w, --width= Set width (defaults: text=80, image=1024) + Select output format (text, source, png, gif, jpeg, + bmp, wbmp) + Default: text + --shapes= Extract specific shape(s); formats are '1' or '1-4' and + can be combined with a comma + --skip-empty Skip empty shapes + --stdin Read from stdin + --stdout Write to stdout + -h, --help Show help for subcommand + -o, --output= Write output to file + -O, --optimize Optimize vector shapes (source only) + -w, --width= Set width (defaults: text=80, image=1024) +``` + +## Sub-command generate + +```shell +$ st generate --help +Usage: st generate [-h] [--demo-code] [--single] [--stdin] [--stdout] + [--address=
] [--name=] [-o=] + [] + +Generate a shape table from source code + +Parameters: + [] File to process + +Options: + --address=
Address for AppleSingle file + Default: 24576 + --demo-code Generate a ProDOS .po image with Applesoft BASIC code + demoing the shape table + --name= Filename assign in AppleSingle file + Default: SHAPES.BIN + --single Write to AppleSingle file (requires address, defaults to + 0x6000) + --stdin Read from stdin + --stdout Write to stdout + -h, --help Show help for subcommand + -o, --output= Write output to file ``` # Features @@ -141,4 +172,15 @@ File dates info: Backup: 2018-06-20T01:36:59Z Data Fork: Present, 14 bytes Resource Fork: Not present -``` \ No newline at end of file +``` + +## Generate demo disk + +Demonstration of a Beagle Bros font: + +```shell +st --debug extract --format=source --coding=short ~/Downloads/shapes/\]WESTERN.dump --stdout --skip-empty --optimize | + st generate --demo-code -o western.po --stdin +``` + +![Western Font Demo](images/western-font-demo.png "]WESTERN") diff --git a/tools/st/images/western-font-demo.png b/tools/st/images/western-font-demo.png new file mode 100644 index 0000000..50ece9d Binary files /dev/null and b/tools/st/images/western-font-demo.png differ