diff --git a/README.md b/README.md index e69de29..282f834 100644 --- 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" +``` +