97 lines
3.9 KiB
Markdown
97 lines
3.9 KiB
Markdown
|
<p align="center">
|
||
|
|
<a title="Go to freesewing.org" href="https://freesewing.org/"><img src="https://freesewing.org/img/logo/black.svg" align="center" width="150px" alt="Freesewing logo"/></a>
|
||
|
|
<br>
|
||
|
|
<a href="https://freesewing.org/">FreeSewing v2</a>
|
||
|
|
</p>
|
||
|
|
<p align="center">A JavaScript library for made-to-measure sewing patterns</p>
|
||
|
|
<p align='center'><a
|
||
|
|
href="https://twitter.com/freesewing_org"
|
||
|
|
title="Follow @freesewing_org on Twitter"
|
||
|
|
><img src="https://img.shields.io/badge/%F3%A0%80%A0-Follow%20us-blue.svg?logo=twitter&logoColor=white&logoWidth=15"
|
||
|
|
alt="Follow @freesewing_org on Twitter"/>
|
||
|
|
</a><a
|
||
|
|
href="https://gitter.im/freesewing/freesewing"
|
||
|
|
title="Chat with us on Gitter"
|
||
|
|
><img src="https://img.shields.io/badge/%F3%A0%80%A0-Chat%20with%20us-CA0547.svg?logo=gitter&logoColor=white&logoWidth=15"
|
||
|
|
alt="Chat with us on Gitter"/>
|
||
|
|
</a><a
|
||
|
|
href="https://freesewing.org/patrons/join"
|
||
|
|
title="Become a FreeSewing Patron"
|
||
|
|
><img src="https://img.shields.io/badge/%F3%A0%80%A0-Support%20us-blueviolet.svg?logo=cash-app&logoColor=white&logoWidth=15"
|
||
|
|
alt="Become a FreeSewing Patron"/>
|
||
|
|
</a><a
|
||
|
|
href="https://instagram.com/freesewing_org"
|
||
|
|
title="Follow @freesewing_org on Twitter"
|
||
|
|
><img src="https://img.shields.io/badge/%F3%A0%80%A0-Follow%20us-E4405F.svg?logo=instagram&logoColor=white&logoWidth=15"
|
||
|
|
alt="Follow @freesewing_org on Twitter"/>
|
||
|
|
</a>
|
||
|
|
</p>
|
||
|
|
|
||
|
|
# hugo example
|
||
|
|
|
||
|
|
This project was bootstrapped with [Create Freesewing Pattern](https://en.freesewing.dev/create-freesewing-pattern):
|
||
|
|
|
||
|
|
```js
|
||
|
|
npm init freesewing-pattern
|
||
|
|
```
|
||
|
|
|
||
|
|
This example folder is part of the local development environment.
|
||
|
|
It is **not** part of the pattern's source code.
|
||
|
|
|
||
|
|
To run this example, follow these steps:
|
||
|
|
|
||
|
|
- In the folder above this one, run: `yarn start` (or `npm start`)
|
||
|
|
- Then, in new terminal, run the same command in this folder: `yarn start` (or `npm start`)
|
||
|
|
|
||
|
|
This will spin up the development environment, similar to [our online demo](https://hugo.freesewing.dev/).
|
||
|
|
|
||
|
|
## About FreeSewing 🤔
|
||
|
|
|
||
|
|
Where the world of makers and developers collide, that's where you'll find FreeSewing.
|
||
|
|
|
||
|
|
Our [core library](https://freesewing.dev/en/freesewing) is a *batteries-included* toolbox
|
||
|
|
for parametric design of sewing patterns. It's a modular system (check our list
|
||
|
|
of [plugins](https://freesewing.dev/en/plugins) and getting started is as simple as:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
npm init freesewing-pattern
|
||
|
|
```
|
||
|
|
|
||
|
|
The [getting started] section on [freesewing.dev](https://freesewing.dev/) is a good
|
||
|
|
entrypoint to our documentation, but you'll find a lot more there, including
|
||
|
|
our [API documentation](https://freesewing.dev/en/freesewing/api),
|
||
|
|
as well as [examples](https://freesewing.dev/en/freesewing/examples),
|
||
|
|
and [best practices](https://freesewing.dev/en/do).
|
||
|
|
|
||
|
|
If you're a maker, checkout [freesewing.org](https://freesewing/) where you can generate
|
||
|
|
our sewing patterns adapted to your measurements.
|
||
|
|
|
||
|
|
## Support FreeSewing: Become a patron 🥰
|
||
|
|
|
||
|
|
FreeSewing is an open source project run by a community,
|
||
|
|
and financially supported by our patrons.
|
||
|
|
|
||
|
|
If you feel what we do is worthwhile, you too
|
||
|
|
should [become a patron](https://freesewing.org/patrons/join).
|
||
|
|
|
||
|
|
## Links 👩💻
|
||
|
|
|
||
|
|
- 💻 Makers website: [freesewing.org](https://freesewing.org)
|
||
|
|
- 💻 Developers website: [freesewing.dev](https://freesewing.org)
|
||
|
|
- 💬 Chat: [gitter.im/freesewing](https://gitter.im/freesewing/freesewing)
|
||
|
|
- 🐦 Twitter: [@freesewing_org](https://twitter.com/freesewing_org)
|
||
|
|
- 📷 Instagram: [@freesewing_org](https://instagram.com/freesewing_org)
|
||
|
|
|
||
|
|
## License: MIT 🤓
|
||
|
|
|
||
|
|
© [Joost De Cock](https://github.com/joostdecock).
|
||
|
|
See [the license file](https://github.com/freesewing/freesewing/blob/develop/LICENSE) for details.
|
||
|
|
|
||
|
|
## Where to get help 🤯
|
||
|
|
|
||
|
|
Our [chatroom on Gitter](https://gitter.im) is the best place to ask questions,
|
||
|
|
share your feedback, or just hang out.
|
||
|
|
|
||
|
|
If you want to report a problem, please [create an issue](https://github.com/freesewing/freesewing/issues/new).
|
||
|
|
|