From dcc74b85698912d9b80a65ec3d1f32b758a9e05c Mon Sep 17 00:00:00 2001 From: arne Date: Sun, 21 Jul 2024 00:41:19 +0200 Subject: [PATCH] Add README --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..70e2e42 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# Hitomezashi Pattern Generation + +Hitomezashi patterns are a form of decorative embroidery used to repair or reinforce clothing. This repository contains a web app to experiment with different kinds of patterns and play around with the shapes that arise. + +## Development + +You need node.js 18 or newer to run the project. Clone the repository and run: + +```bash +npm install +npm run dev +``` + +## Build + +After installing the dependencies (see above), you can build a static version like so: + +```bash +npm run build +``` + +The resulting web app will be in the `dist` folder.