Added README and clamped code point values.

1 files changed, 53 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..e01202a
--- /dev/null
+++ b/README
@@ -0,0 +1,53 @@
+USAGE
+=====
+This is a simple tool to generate data for a map as defined using ASCII art.
+
+usage: ascii2map [-a|-b|-c] [-d directive] [input-file [output-file]]
+
+SWITCHES
+========
+
+-a		The default.  Produce assembly output.
+-b		Produce binary output.
+-c		Produce C source output.
+-d "x"		In assembly mode use "x" as the directive instead of the
+		default "byte".
+input-file	The input file.  If not supplied stdin is used.
+output-file	The output file.  If not supplied stdout is used.
+
+
+INPUT FILES
+===========
+
+Input files look like the following:
+
+#:1
+*:128
+!63
+~
+########
+#      #
+#ABCDEF#
+#1# # *#
+########
+
+The "#:1" line defines that when a '#' character appears in the map then code
+'1' should be used.
+
+The following line defines the offset for any characters that aren't explicitly
+defined.  e.g. in this example 63 will be deducted from the character code.
+In ASCII this would mean 'A' becomes 2, 'B' becomes 3, and so on.  Any codes
+generated that fall outside the range 0 to 255 will be clamped to that range.
+
+The line with a tilde (~) on its own indicates the end of the definitions.
+
+Following it is the map to produce the definition for, eg.
+
+$ ascii2map example
+	byte	1, 1, 1, 1, 1, 1, 1, 1
+	byte	1, 0, 0, 0, 0, 0, 0, 1
+	byte	1, 2, 3, 4, 5, 6, 7, 1
+	byte	1, 0, 1, 0, 1, 0, 128, 1
+	byte	1, 1, 1, 1, 1, 1, 1, 1
+
+The following switch