Merge pull request #17 from IEAWindTask37/cleanup_and_dcument

Cleanup and dcument

README.md

@@ -1,7 +1,31 @@
 # windio2cad
 
-Example command line:
+## What is `windio2cad`?
+
+The `windio2cad` module is a command line tool to convert `.yaml` files that follow the [windio ontology](https://windio.readthedocs.io/en/latest/) into `.stl` CAD files. These CAD files can then be used as input to other codes or for visualization.
+
+Two example files for floating offshore wind turbine (FOWT) platforms are included in this source repository:
+
+- `nrel5mw-spar_oc4.yaml`: A semisubmersible floating platform.
+
+- `nrel5mw-spar_oc3.yaml`: A spar-type floating platform.
+
+Read below to learn more about rendering these `.yaml` files into `.stl` files.
+
+## Installation
+
+Clone the repository and change into the repository's directory:
 
 ``` 
-python semisubmersible_yaml_to_stl.py --input semisubmersible.yaml --output semisubmersible2.stl --modules modules_for_rendering_semisubmersible.scad --openscad "/Applications/OpenSCAD.app/Contents/MacOS/OpenSCAD"
+pip install -e .
+```
+
+This module depends on the OpenSCAD package to be installed to render the final `.stl` file. See [http://www.openscad.org/](http://www.openscad.org/)
+
+## Usage
+
+On a macOS system with OpenSCAD installed in its default location, use the following command to create an `.stl` file for a turbine atop a semisubmersible foundation:
+
+```
+python -m windio2cad --input nrel5mw-spar_oc3.yaml --output turbine.stl --openscad /Applications/OpenSCAD.app/Contents/MacOS/OpenSCAD
 ```