From a15d56065ef589078fae682c9716f4447c9791cb Mon Sep 17 00:00:00 2001
From: alpine9000 <alex.g.brown@gmail.com>
Date: Tue, 26 Apr 2016 14:00:45 +1000
Subject: [PATCH] Update fade readme

---
 tools/fade/README.md | 57 ++++++++++++++++++++++++++++++++++++++++++++
 tools/fade/fade.c    |  3 +++
 2 files changed, 60 insertions(+)
 create mode 100644 tools/fade/README.md

diff --git a/tools/fade/README.md b/tools/fade/README.md
new file mode 100644
index 0000000..4093f14
--- /dev/null
+++ b/tools/fade/README.md
@@ -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
diff --git a/tools/fade/fade.c b/tools/fade/fade.c
index a95cf07..dd0a7e8 100644
--- a/tools/fade/fade.c
+++ b/tools/fade/fade.c
@@ -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]);