Readme updated

added usage info and config description closes #7
rumkit · Nov 15, 2016 · 56ebcc5 · 56ebcc5
1 parent 5bc6393
commit 56ebcc5
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 25 deletions.
diff --git a/Pixie/Properties/AssemblyInfo.cs b/Pixie/Properties/AssemblyInfo.cs
@@ -36,9 +36,9 @@
 // You can specify all the values or you can default the Build and Revision Numbers 
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("1.1.*")]
-[assembly: AssemblyFileVersion("1.1.0.0")]
-[assembly: AssemblyInformationalVersion("1.1")]
+[assembly: AssemblyVersion("1.2.*")]
+[assembly: AssemblyFileVersion("1.2.0.0")]
+[assembly: AssemblyInformationalVersion("1.2")]
 [assembly: AssemblyUsage(
     "Usage: pixie parse someimage.bmp",
     "       pixie parse input.bmp --output=array.txt -c myconfig.json",

diff --git a/README.md b/README.md
@@ -15,46 +15,54 @@ And here is a solution for you problem! PixelPixie is a bitmap font generator th
 #### Usage
 
 ```
-Pixie 1.0
+Pixie 1.2
 Copyright c  2016
-Usage: pixie --input=input.bmp
-       pixie -i input.bmp -o array.txt -c myconfig.json
-       pixie -g -o pattern.png -w 5 -h 10
+Usage: pixie parse someimage.bmp
+       pixie parse input.bmp --output=array.txt -c myconfig.json
+       pixie generate -w 5 -h 10
 
-  -s, --single-array    place all characters to single array
+  generate    generates a graphical pattern
 
-  -c, --config          (Default: config.json) configuration file path
+  parse       parses  a pattern filled with graphical font to a byte array
+```
 
-  -o, --output          Required. output file name
+```
+pixie generate
 
-  -i, --input           output file name
+  -w, --width     grid pattern width in symbols
 
-  -g, --generate        generate grid pattern
+  -h, --height    grid pattern height in symbols
 
-  -w, --width           grid pattern width in symbols
+  -o, --output    (Default: output.png) output file name
 
-  -h, --height          grid pattern height in symbols
+  -c, --config    (Default: config.json) configuration file path
+```
 
-  --help                Display this help screen.
 ```
+pixie parse
 
+  -s, --single-array    place all characters to single array
+
+  -o, --output          (Default: output.txt) output file name
 
+  -c, --config          (Default: config.json) configuration file path
+```
 
 #### Configuration
 
-All configuration is done via JSON config file:
+All configuration is done via JSON config file. Please note that comments are not allowed normally in JSON and listed here only as reference.
 
 ```json
 {
-  "BitsPerPixel": 2,
-  "SymbolWidth": 12,
-  "SymbolHeight": 18,
-  "DelimeterWidth": 1,
-  "DelimeterHeight": 1,
-  "DelimeterColor": "#FF0000",
-  "ColorMapping": {
-    "#FFFFFF": 0,
-    "#000000": 1,
+  "BitsPerPixel": 2,				// How many bits per pixel are used in a result array
+  "SymbolWidth": 12,				// One symbol dimensions in pixels
+  "SymbolHeight": 18,				//
+  "DelimeterWidth": 1,				// Symbol delimeter width and height
+  "DelimeterHeight": 1,				//
+  "DelimeterColor": "#FF0000",		// Color of delimeter in generated pattern
+  "ColorMapping": {					// A dictionary that is used to map a color in bitmap to
+    "#FFFFFF": 0,					// a bit sequence. Bit sequence is stored in DEC. And
+    "#000000": 1,					// only first N bits (BitsPerPixel) are taken in account
     "#969696": 2
   }
 }