Merge: nitunit: Use markdown2

[nit.git] / contrib / inkscape_tools / README.md

diff --git a/contrib/inkscape_tools/README.md b/contrib/inkscape_tools/README.md
index 017ec86..b279d0f 100644 (file)
--- a/contrib/inkscape_tools/README.md
+++ b/contrib/inkscape_tools/README.md
@@ -1,28 +1,42 @@
-# SVG to PNG and Nit
+tools to extract images from SVG files: `svg_to_icons` for app icons and `svg_to_png_and_nit` for game sprites
 
-This tool is used in combination with Inkscape to simplify assets creation for _mnit_ apps. It uses Inkscape to extract a PNG file from a SVG file. It will also create a Nit source file to create _mnit_ images for each objects with an id beginning by 0.
+Both tools use Inkscape for to read the SVG files and extract the images.
 
-# Features
+# Create applications icons
 
-* Creates a sinlge PNG file per SVG source file
-* Creates subimages for objects with an id beginning by 0.
-* If the id ends with 0 to 9, will instead create an array of subimages.
+`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_.
 
-# Usage
+## Variations
 
-1. Create a new Inkscape document.
-2. Create objects and set their ids to begin with 0
-3. Save the document (ex: to `drawing.svg`) the name of the file is important
-4. Execute `bin/svg_to_png_and_nit drawing.svg`
-5. From your code, import the generated source file (at  src/drawing.nit`)
-6. Use the class `DrawingImages` and its attributes.
+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.
 
-# Examples
+# Create game sprites and a module to load them
 
-The minimal test in  tests/app/  shows the basic usage of this tool.
+`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`.
 
-The Dino example `../../../../examples/mnit_dino` also uses this tool and is a more complete and practical example.
+It produces two files:
 
-# Authors
+* 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 id ends with a digit, then it will be an array.
 
-Alexis Laferrière <alexis.laf@xymus.net>
+* A single PNG image file that contains all the selected objects.
+       With the option `--pow2`, the image size is rounded to the next power of 2.
+
+## Usage
+
+1. Create a new Inkscape document.
+2. Create objects and set their ids to begin with `0`.
+3. Save the document to `drawing.svg` (for this example), the name of the file is used to name the Nit class.
+4. Execute `bin/svg_to_png_and_nit drawing.svg`
+5. From your code, import the generated source file at `src/drawing.nit`.
+6. Use the class `DrawingImages` and its attributes.