doc: Add readme documentation
This commit is contained in:
parent
9c3948401f
commit
6942e1f218
17
README.md
17
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"
|
||||||
|
```
|
||||||
|
|
Loading…
Reference in New Issue