Add README
This commit is contained in:
parent
e649f630c1
commit
dcc74b8569
1 changed files with 22 additions and 0 deletions
22
README.md
Normal file
22
README.md
Normal file
|
|
@ -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.
|
||||||
Loading…
Add table
Add a link
Reference in a new issue