improve documentation
[Printer-EVOLIS.git] / README
diff --git a/README b/README
index 53d8c3a..ab53243 100644 (file)
--- a/README
+++ b/README
@@ -15,18 +15,30 @@ DESCRIPTION
     especially when generating front and back pages separatly.
 
 SCRIPTS
-    Current toolset sonsists of following scripts:
+    Current toolset consists of following scripts:
 
   scripts/inkscape-render.pl card/template.svg 201008159999 Name Surname
-    generate pbm files from Inkscape SVG template in `card/'
+    Generate pdf files from Inkscape SVG template in `card/' using
+    `print-front' and `print-back' object IDs. Layers doesn't work since we
+    can't toggle visilbity easily. To print more than one object gruop them
+    and change ID of group.
+
+    After pdf files are created, GhostScript is used to rasterize them into
+    pbm (monochrome) bitmaps.
 
   scripts/evolis-driver.pl front.pbm back.pbm > evolis.commands
-    provides driver which generates printer commands
+    Provides driver which generates printer command stream to print
+    two-sided card from pbm files.
 
   scripts/evolis-simulator.pl evolis
-    provides simulator for EVOLIS printer which is useful for development
+    Simulator for EVOLIS printer commands which is useful for development.
+    It creates one pbm file per page printed.
 
 EXAMPLE
+    Following is simple walk-through from svg image in Inkscape to evolis
+    command stream which can be executed in top-level directory of this
+    distribution:
+
       ./scripts/inkscape-render.pl card/ffzg-2010.svg 201008159999 Ime Prezime
       ./scripts/evolis-driver.pl out/201008159999.front.pbm out/201008159999.back.pbm > evolis
       ./scripts/evolis-simulator.pl evolis