1
0
Fork 0
freesewing/packages/utils/README.md

101 lines
4.2 KiB
Markdown
Raw Normal View History

2019-10-24 18:52:12 +02:00
![FreeSewing](https://freesewing.org/banner.jpg)
2019-04-27 12:21:14 +02:00
<p align='center'><a
href="https://www.npmjs.com/package/@freesewing/utils"
title="@freesewing/utils on NPM"
2019-05-10 15:08:07 +02:00
><img src="https://img.shields.io/npm/v/@freesewing/utils.svg"
2019-04-27 12:21:14 +02:00
alt="@freesewing/utils on NPM"/>
</a><a
href="https://opensource.org/licenses/MIT"
title="License: MIT"
2019-05-10 15:08:07 +02:00
><img src="https://img.shields.io/npm/l/@freesewing/utils.svg?label=License"
2019-04-27 12:21:14 +02:00
alt="License: MIT"/>
</a><a
2019-05-10 15:17:31 +02:00
href="https://deepscan.io/dashboard#view=project&tid=2114&pid=2993&bid=23256"
title="Code quality on DeepScan"
><img src="https://deepscan.io/api/teams/2114/projects/2993/branches/23256/badge/grade.svg"
alt="Code quality on DeepScan"/>
</a><a
2019-04-27 12:21:14 +02:00
href="https://github.com/freesewing/freesewing/issues?q=is%3Aissue+is%3Aopen+label%3Apkg%3Autils"
title="Open issues tagged pkg:utils"
><img src="https://img.shields.io/github/issues/freesewing/freesewing/pkg:utils.svg?label=Issues"
alt="Open issues tagged pkg:utils"/>
</a></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
2019-08-13 18:58:53 +02:00
href="https://gitter.im/freesewing/chat"
2019-04-27 12:21:14 +02:00
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>
2019-10-24 18:52:12 +02:00
## What am I looking at? 🤔
2020-08-14 15:14:56 +02:00
This repository is our *monorepo* holding [all our NPM packages](https://www.npmjs.com/search?q=keywords:freesewing).
2019-10-24 18:52:12 +02:00
This folder holds **@freesewing/utils**
2019-04-27 12:21:14 +02:00
A collection of utilities shared across freesewing projects
2019-04-27 12:21:14 +02:00
2020-08-14 15:14:56 +02:00
2019-10-24 18:52:12 +02:00
## About FreeSewing 💀
2019-04-27 12:21:14 +02:00
Where the world of makers and developers collide, that's where you'll find FreeSewing.
2020-08-14 15:14:56 +02:00
Our [core library](https://freesewing.dev/reference/api/) is a *batteries-included* toolbox
2019-04-27 12:21:14 +02:00
for parametric design of sewing patterns. It's a modular system (check our list
2020-03-16 09:29:25 +01:00
of [plugins](https://freesewing.dev/reference/plugins/) and getting started is as simple as:
2019-04-27 12:21:14 +02:00
```bash
npm init freesewing-pattern
```
2020-03-16 09:29:25 +01:00
The [getting started](https://freesewing.dev/guides/getting-started/) section on [freesewing.dev](https://freesewing.dev/) is a good
2019-04-27 12:21:14 +02:00
entrypoint to our documentation, but you'll find a lot more there, including
2020-03-16 09:29:25 +01:00
our [API reference](https://freesewing.dev/reference/api/),
as well as [our turorial](https://freesewing.dev/tutorials/pattern-design/),
and [howtos](https://freesewing.dev/howtos/).
2019-04-27 12:21:14 +02:00
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 🥰
2020-08-14 15:14:56 +02:00
FreeSewing is an open source project run by a community,
2019-04-27 12:21:14 +02:00
and financially supported by our patrons.
2020-08-14 15:14:56 +02:00
If you feel what we do is worthwhile, you too
2019-04-27 12:21:14 +02:00
should [become a patron](https://freesewing.org/patrons/join).
## Links 👩‍💻
2020-08-14 15:14:56 +02:00
- 💻 Makers website: [freesewing.org](https://freesewing.org)
- 💻 Developers website: [freesewing.dev](https://freesewing.dev)
- 💬 Chat: [gitter.im/freesewing](https://gitter.im/freesewing/chat)
- 🐦 Twitter: [@freesewing_org](https://twitter.com/freesewing_org)
- 📷 Instagram: [@freesewing_org](https://instagram.com/freesewing_org)
2019-04-27 12:21:14 +02:00
## 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 🤯
2019-08-13 18:58:53 +02:00
Our [chatroom on Gitter](https://gitter.im/freesewing/chat) is the best place to ask questions,
2019-04-27 12:21:14 +02:00
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).