Initial commit

Author: tomvanmele

README.md

@@ -0,0 +1,28 @@
+# COMPAS Framework
+
+The COMPAS framework packages
+
+## Installation
+
+Stable releases can be installed from PyPI.
+
+```bash
+pip install compas_framework
+```
+
+To install the latest version for development, do:
+
+```bash
+git clone https://github.com/compas-dev/compas_framework.git
+cd compas_framework
+pip install -e ".[dev]"
+```
+
+## Documentation
+
+For further "getting started" instructions, a tutorial, examples, and an API reference,
+please check out the online documentation here: [COMPAS Framework docs](https://compas-dev.github.io/compas_framework)
+
+## Issue Tracker
+
+If you find a bug or if you have a problem with running the code, please file an issue on the [Issue Tracker](https://github.com/compas-dev/compas_framework/issues).