doc: Add readme documentation

2024-06-14 20:39:17 -07:00 · 2024-06-14 20:39:17 -07:00 · 6942e1f218
parent 9c3948401f
commit 6942e1f218
1 changed files with 17 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,17 @@
+# Cosplay
+
+This is the design repository for NorCal Hakkero Factory No. 1.
+
+## Development
+
+Most cosplay schematics are created with Blender, CadQuery, and Inkscape. To
+enter into a CadQuery environment, install `poetry` and use
+```sh
+poetry install
+poetry shell
+```
+and this should succeed
+```sh
+python3 -c "import nhf"
+```
+