contrib/inkscape_tools: update README
authorAlexis Laferrière <alexis.laf@xymus.net>
Sat, 13 Feb 2016 21:29:38 +0000 (16:29 -0500)
committerAlexis Laferrière <alexis.laf@xymus.net>
Tue, 16 Feb 2016 01:10:29 +0000 (20:10 -0500)
Signed-off-by: Alexis Laferrière <alexis.laf@xymus.net>

contrib/inkscape_tools/README.md

index f1dccff..62b9623 100644 (file)
@@ -1,15 +1,36 @@
-# Tools to extract images from SVG files using Inkscape, either to create icons or game sprites
+tools to extract images from SVG files: `svg_to_icons` for app icons and `svg_to_png_and_nit` for game sprites
 
-This tool uses Inkscape to prepare assets for Nit applications from a single SVG file.
-It selects objects to extract from the SVG file when their id begins with `0`.
+Both tools use Inkscape for to read the SVG files and extract the images.
 
-It will produce two files:
+# Create applications icons
+
+`svg_to_icons` creates icons for Android, iOS and the stores from an SVG file.
+The icons are generated with the formats and minimum file structure expected by the target platform.
+This tools works especially well with _app.nit_.
+
+## Variations
+
+The `--android` option generates the folders drawable-hdpi, drawable-xhdpi, etc. with the corresponding icon within.
+
+The `--ios` option generates many different icon formats for different iOS devices,
+along with the `Contents.json` file as expected by Xcode.
+
+## Usage examples
+
+See the portable applications at `contrib/tnitter` and `examples/calculator` for practical usages of this tool.
+
+# Create game sprites and a module to load them
+
+`svg_to_png_and_nit` prepares sprite assets for Nit applications from a single SVG file.
+It selects the objects to extract from the SVG file when their id begins with `0`.
+
+It produces two files:
 
 * A Nit source file that declares a single class with an attribute for each selected object.
-  The attribute usually holds a single texture, except if the the id ends with a digit, then it will be an array.
+       The attribute usually holds a single texture, except if the id ends with a digit, then it will be an array.
 
 * A single PNG image file that contains all the selected objects.
-  With the option `--pow2`, the image size is rounded to the next of 2.
+       With the option `--pow2`, the image size is rounded to the next power of 2.
 
 ## Usage