README

README.md

+# RoCo backend
+
+## Generate custom 2D patterns for papercraft, lasercutter, or wood
+
+### Requirements
+
+- Python 3
+- `pip`
+- `virtualenv` (optional)
+
+### Install
+
+(optionally) create a virtualenv, and pip install the rocolib library:
+```
+pip install git+https://git.uclalemur.com/roco/rocolib#egg=rocolib
+```
+
+### Usage
+
+If you created a virtualenv during install, enter it.  Then, you can import and use this module in scripts or the python REPL.
+
+See [a simple tutorial](https://git.uclalemur.com/roco/tutorial) for more details on how to use RoCo.
+
+### Development
+
+```
+% git clone https://git.uclalemur.com/roco/rocolib.git
+% ./vstart.sh
+```
+
+`vstart.sh` creates the virtualenv and pip installs the requirements on first run; it launches a shell within that virtualenv whenever run.  Editing the source code will be reflected in the rocolib modules whenever re-imported.