From 6942e1f218e675c2275d68975371ceb03be2bfb8 Mon Sep 17 00:00:00 2001
From: Leni Aniva <v@leni.sh>
Date: Fri, 14 Jun 2024 20:39:17 -0700
Subject: [PATCH] doc: Add readme documentation

---
 README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

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"
+```
+