adding readme

README.rst

@@ -0,0 +1,40 @@
+generate labels for hs electronics components printed on A4 sticker paper
+
+Current version is optimized for A4 sheets precut into 70 x 37.125 mm
+(3 columns and 8 rows portait). Two 35 x 37 mm labels are fit in one precut
+piece. Outer spaces (near edges) are avoided to mitigate common printer margin
+limitations. This space can be utilized for printing small uuid datamatrix
+pieces.
+
+Input file
+----------
+Example yaml filed specifying labels contents:
+
+.. code:: yaml
+
+  - name: "74HC165"
+    type: "IC logic"
+    description: "8-bit parallel-in/serial out shift register"
+    condition: "new"
+    count: 2
+    datasheet: "https://assets.nexperia.com/documents/data-sheet/74HC_HCT165.pdf"
+    package: "SOIC127P600X175-16"
+
+  - name: "MAX5033"
+    type: "IC power managment"
+    description: "DC-DC Step Down converter 76v 0.5A"
+    condition: "new"
+    count: 2
+    datasheet: "http://datasheets.maximintegrated.com/en/ds/MAX5033.pdf"
+
+Licensing
+---------
+Two files in this project are copied from inkscape-extensions_ and are licensed
+under GNU General Public License. Those files are:
+
+* label_gen/datamatrix.py
+* label_gen/simplestyle.py
+
+Everything else is licensed under zlib license.
+
+.. _inkscape-extensions: https://gitlab.com/inkscape/extensions