Update fade readme

This commit is contained in:
alpine9000 2016-04-26 14:00:45 +10:00
parent 1f1efd05da
commit a15d56065e
2 changed files with 60 additions and 0 deletions

57
tools/fade/README.md Normal file
View File

@ -0,0 +1,57 @@
fade
====
Generate data for fading between color palettes
usage
-----
```
fade: --output <output>
options:
--to <file.pal>
--from <file.pal>
--from-grey
--from-black
--steps <num steps> (default: 16)
--colors <num colors> (default: 16)
--verbose
```
fade will generate 68000 assembler data for fading between two amiga color palettes. The output it written to stdout.
mandatory arguments
-------------------
**--output** &lt;output.png>
Specify the name used for creating symbols used in the data. In addition exactly on "to" and one "from" option must be specified.
options
-------
**--to** &lt;file.pal>
The palette file used for the destination palette (will fade to this palette)
**--from** &lt;from.pal>
The palette file used for the source palette (will fade from this palette)
**--from-grey**
Fade from a grey version of the "to" palette
**--from-black**
Fade from a black version of the "to" palette
**--steps** &lt;num steps>
The number of steps in the fade
**--colors** &lt;num colors>
The number of colors in the palette
**--verbose**
Display debugging information

View File

@ -43,7 +43,10 @@ usage()
"%s: --output <output>\n"\
"options:\n"\
" --to <file.pal>\n"\
" --from <file.pal>\n"\
" --from-grey\n"\
" --from-black\n"\
" --steps <num steps> (default: 16)\n"\
" --colors <num colors> (default: 16)\n"\
" --verbose\n\n"\
"Exactly one 'to' and 'from' option must be specified\n", config.argv[0]);