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

50 lines
2.7 KiB
Markdown
Raw Normal View History

> **NOTE:** We are currently switching to a monorepo, which is causing some turbulence.
>
> Join [our chat room](https://gitter.im/freesewing/freesewing) for questions and support.
2018-07-18 17:00:17 +00:00
<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>
</p>
<h4 align="center"><em>&nbsp;<a title="Go to freesewing.org" href="https://freesewing.org/">freesewing</a></em>
<br><sup>a library for made-to-measure sewing patterns</sup>
</h4>
2018-08-13 09:23:08 +02:00
<p align="center">
<a href="https://travis-ci.org/freesewing/core"><img src="https://badgen.net/travis/freesewing/core/master" alt="Travis build"></a>
<a href="https://www.npmjs.com/package/@freesewing/core"><img src="https://badgen.net/npm/v/@freesewing/core" alt="Version"></a>
<a href="https://www.npmjs.com/package/@freesewing/core"><img src="https://badgen.net/npm/license/@freesewing/core" alt="License"></a>
2018-08-13 10:26:49 +02:00
<a href="https://codecov.io/gh/freesewing/freesewing"><img src="https://badgen.net/codecov/c/github/freesewing/freesewing/master" alt="Code coverage"></a>
<a href="https://deepscan.io/dashboard#view=project&pid=2993&bid=23256"><img src="https://deepscan.io/api/projects/2993/branches/23256/badge/grade.svg" alt="DeepScan grade"></a>
2018-08-13 09:37:43 +02:00
<a href="https://gitter.im/freesewing/freesewing"><img src="https://badgen.net/badge/chat/on%20Gitter/cyan" alt="Chat on Gitter"></a>
<a href="https://freesewing.org/patrons/join"><img src="https://badgen.net/badge/become/a%20Patron/FF5B77" alt="Become a Patron"></a>
2018-08-13 09:23:08 +02:00
</p>
2018-08-13 09:50:51 +02:00
2018-07-06 16:38:43 +02:00
# freesewing
2018-07-09 08:38:58 +00:00
2019-01-26 13:17:14 +01:00
[Freesewing](https://freesewing.org/) is an open source platform for made-to-measure sewing patterns.
Try [the online demo](https://beta.freesewing.org/en/demo/) to *get it*.
2018-08-13 09:23:08 +02:00
2018-08-13 09:50:51 +02:00
## Links
2018-08-13 09:23:08 +02:00
2018-08-13 09:51:34 +02:00
- 💻 Website: [freesewing.org](https://freesewing.org)
2018-08-13 09:50:51 +02:00
- 💬 Chat: [Gitter](https://gitter.im/freesewing/freesewing)
- 🐦 Twitter: [@freesewing_org](https://twitter.com/freesewing_org)
- 📷 Instagram: [@freesewing_org](https://instagram.com/freesewing_org)
## Features
2018-08-13 09:23:08 +02:00
2018-08-13 09:53:07 +02:00
- Parametric design of sewing patterns
2018-08-13 09:50:51 +02:00
- Modular design with support for [plugins](https://github.com/freesewing/plugins)
2018-08-13 09:54:45 +02:00
- Auto-layout of pattern parts
- Auto-offset of paths for seam allowance
- Support for paperless patterns (with [our theme plugin](https://github.com/freesewing/plugin-theme))
2018-08-13 09:50:51 +02:00
- Sampling of options, a single measurement, or across models
- Renders to SVG
- Run in the browser as well as on the server with Node.js
2018-08-13 09:23:08 +02:00
2018-08-13 09:50:51 +02:00
## Getting started
2018-08-13 09:23:08 +02:00
**@freesewing/core** is a rewrite of [freesewing/core](https://github.com/freesewing/core) in JavaScript.
2018-07-18 17:00:17 +00:00
2018-08-13 09:50:51 +02:00
It is an ongoing project, and not ready for prime-time yet. Watch this space.