📝 Add basic instructions

2021-08-16 23:33:37 +01:00 · 2021-08-16 23:33:37 +01:00 · 14361c7d80
parent 206c6e1bf0
commit 14361c7d80
1 changed files with 15 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,15 @@
+# OpenSCAD-pyOptimizer
+
+Parse optimizer parameters from SCAD files.
+
+## Using the library
+
+Pull the repository and install the plugin with pip:
+
+```bash
+git clone https://forge.lunai.re/rodolphe/openscad-pyoptimizer
+cd openscad-pyoptimizer
+pip install -e .
+```
+
+You can then use the `customizer.py` to read an OpenSCAD file and display the parameters in JSON format.