From 51e3aa83ce5c42b20bb8fcdcb2d781437b64832b Mon Sep 17 00:00:00 2001 From: Joost De Cock Date: Fri, 19 Apr 2019 20:48:29 +0200 Subject: [PATCH] :wrench: Changes badges layout in READMEs --- config/badges.yaml | 31 ++- config/descriptions.yaml | 2 +- config/templates/readme.dflt.md | 33 ++-- packages/aaron/README.md | 74 ++++--- packages/bent/README.md | 76 +++++--- packages/brian/README.md | 81 ++++---- packages/bruce/README.md | 81 ++++---- packages/carlita/README.md | 81 ++++---- packages/carlton/README.md | 81 ++++---- packages/cathrin/README.md | 81 ++++---- packages/components/README.md | 111 +++++------ packages/core/README.md | 103 +++++----- packages/create-freesewing-pattern/README.md | 52 ++++- packages/css-theme/README.md | 56 +++++- packages/examples/README.md | 64 +++++-- packages/florent/README.md | 81 ++++---- packages/huey/README.md | 74 ++++--- packages/hugo/README.md | 81 ++++---- packages/i18n/README.md | 79 +++++--- packages/jaeger/README.md | 81 ++++---- packages/models/README.md | 95 ++++----- packages/mui-theme/README.md | 78 +++++--- .../.editorconfig | 0 .../{pattern-bundle => patterns}/.gitignore | 0 .../{pattern-bundle => patterns}/.npmignore | 0 .../{pattern-bundle => patterns}/README.md | 72 ++++--- packages/{pattern-bundle => patterns}/info.md | 0 .../{pattern-bundle => patterns}/package.json | 10 +- .../rollup.config.js | 0 .../{pattern-bundle => patterns}/rollup.js | 0 .../{pattern-bundle => patterns}/src/index.js | 0 .../src/info/aaron.js | 0 .../src/info/bent.js | 0 .../src/info/brian.js | 0 .../src/info/bruce.js | 0 .../src/info/carlton.js | 0 .../src/info/cathrin.js | 0 .../src/info/huey.js | 0 .../src/info/hugo.js | 0 .../src/info/index.js | 0 .../src/info/jaeger.js | 0 .../src/info/simon.js | 0 .../src/info/sven.js | 0 .../src/info/tamiko.js | 0 .../src/info/trayvon.js | 0 .../src/info/wahid.js | 0 .../{pattern-bundle => patterns}/updateall | 0 packages/plugin-banner/README.md | 113 +++++------ packages/plugin-bundle/README.md | 109 +++++------ packages/plugin-bust/README.md | 131 +++++-------- packages/plugin-buttons/README.md | 113 +++++------ packages/plugin-cutonfold/README.md | 154 +++++---------- packages/plugin-debug/README.md | 120 +++++------- packages/plugin-designer/README.md | 128 +++++-------- packages/plugin-dimension/README.md | 180 +++++------------- packages/plugin-flip/README.md | 110 +++++------ packages/plugin-grainline/README.md | 152 +++++---------- packages/plugin-i18n/README.md | 122 +++++------- packages/plugin-logo/README.md | 115 +++++------ packages/plugin-round/README.md | 114 +++++------ packages/plugin-scalebox/README.md | 149 +++++---------- packages/plugin-sprinkle/README.md | 117 +++++------- packages/plugin-svgattr/README.md | 103 +++++----- packages/plugin-theme/README.md | 112 +++++------ packages/plugin-title/README.md | 129 +++++-------- packages/plugin-validate/README.md | 123 +++++------- packages/shin/README.md | 74 ++++--- packages/simon/README.md | 81 ++++---- packages/sven/README.md | 81 ++++---- packages/tamiko/README.md | 74 ++++--- packages/trayvon/README.md | 74 ++++--- packages/wahid/README.md | 74 ++++--- packages/workbench/README.md | 85 +++++---- scripts/reconfigure.js | 22 ++- 74 files changed, 2265 insertions(+), 2352 deletions(-) rename packages/{pattern-bundle => patterns}/.editorconfig (100%) rename packages/{pattern-bundle => patterns}/.gitignore (100%) rename packages/{pattern-bundle => patterns}/.npmignore (100%) rename packages/{pattern-bundle => patterns}/README.md (64%) rename packages/{pattern-bundle => patterns}/info.md (100%) rename packages/{pattern-bundle => patterns}/package.json (82%) rename packages/{pattern-bundle => patterns}/rollup.config.js (100%) rename packages/{pattern-bundle => patterns}/rollup.js (100%) rename packages/{pattern-bundle => patterns}/src/index.js (100%) rename packages/{pattern-bundle => patterns}/src/info/aaron.js (100%) rename packages/{pattern-bundle => patterns}/src/info/bent.js (100%) rename packages/{pattern-bundle => patterns}/src/info/brian.js (100%) rename packages/{pattern-bundle => patterns}/src/info/bruce.js (100%) rename packages/{pattern-bundle => patterns}/src/info/carlton.js (100%) rename packages/{pattern-bundle => patterns}/src/info/cathrin.js (100%) rename packages/{pattern-bundle => patterns}/src/info/huey.js (100%) rename packages/{pattern-bundle => patterns}/src/info/hugo.js (100%) rename packages/{pattern-bundle => patterns}/src/info/index.js (100%) rename packages/{pattern-bundle => patterns}/src/info/jaeger.js (100%) rename packages/{pattern-bundle => patterns}/src/info/simon.js (100%) rename packages/{pattern-bundle => patterns}/src/info/sven.js (100%) rename packages/{pattern-bundle => patterns}/src/info/tamiko.js (100%) rename packages/{pattern-bundle => patterns}/src/info/trayvon.js (100%) rename packages/{pattern-bundle => patterns}/src/info/wahid.js (100%) rename packages/{pattern-bundle => patterns}/updateall (100%) diff --git a/config/badges.yaml b/config/badges.yaml index 5fd8d3e1905..e187a7865b0 100644 --- a/config/badges.yaml +++ b/config/badges.yaml @@ -1,33 +1,26 @@ _all: + npm: + link: "https://www.npmjs.com/package/{{{fullname}}}" + img: "https://badgen.net/npm/v/{{{fullname}}}" + alt: "{{{fullname}}} on NPM" + license: + link: "https://opensource.org/licenses/MIT" + img: "https://badgen.net/badge/License/MIT/blue" + alt: "License: MIT" +_social: gitter: link: "https://gitter.im/freesewing/freesewing" - img: "https://badgen.net/badge/Gitter/Chat%20with%20us/CA0547?icon=gitter" + img: "https://badgen.net/badge//Chat/CA0547?icon=gitter" alt: "Chat with us on Gitter" twitter: link: "https://twitter.com/freesewing_org" - img: "https://badgen.net/badge/Twitter/@freesewing_org/1DA1F2?icon=twitter" + img: "https://badgen.net/badge//@freesewing_org/1DA1F2?icon=twitter" alt: "Follow @freesewing_org on Twitter" github: link: "https://github.com/freesewing" - img: "https://badgen.net/badge/GitHub/freesewing/269F42?icon=github" + img: "https://badgen.net/badge//freesewing/269F42?icon=github" alt: "FreeSewing on GitHub" patron: link: "https://freesewing.org/patrons/join" img: "https://badgen.net/badge/Become%20a/Patron/purple" alt: "Become a FreeSewing Patron" - license: - link: "https://opensource.org/licenses/MIT" - img: "https://badgen.net/badge/License/MIT/blue" - alt: "License: MIT" - npm: - link: "https://freesewing.org/patrons/join" - img: "https://badgen.net/badge/Become%20a/Patron/purple" - alt: "Become a FreeSewing Patron" - org: - link: "https://freesewing.org/" - img: "https://badgen.net/badge/FreeSewing/.org/3DA639" - alt: "FreeSewing.org" - dev: - link: "https://freesewing.dev/" - img: "https://badgen.net/badge/FreeSewing/.dev/3DA639" - alt: "FreeSewing.dev" diff --git a/config/descriptions.yaml b/config/descriptions.yaml index 0e2c052897f..8a12dff7144 100644 --- a/config/descriptions.yaml +++ b/config/descriptions.yaml @@ -17,7 +17,7 @@ i18n: "Translations for the FreeSewing project" jaeger: "A FreeSewing pattern for a sport coat style jacket" models: "Body measurements data for a range of default sizes" mui-theme: "A Material-UI theme for FreeSewing web UIs" -pattern-bundle: "An umbrella package for all FreeSewing patterns" +patterns: "An umbrella package for all FreeSewing patterns" plugin-banner: "A FreeSewing plugin to repeat text on a path" plugin-bundle: "An umbrella package of 8 essential FreeSewing build-time plugins" plugin-bust: "A FreeSewing plugin that helps with bust-adjusting menswear patterns" diff --git a/config/templates/readme.dflt.md b/config/templates/readme.dflt.md index a25a4b938aa..ee3ceaba7cd 100644 --- a/config/templates/readme.dflt.md +++ b/config/templates/readme.dflt.md @@ -1,29 +1,19 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

{{{badges}}}

+{{{badges}}} -# {{fullname}} +# {{{fullname}}} {{description}} {{{info}}} -## 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 helpLicense - -MIT © [freesewing](https://github.com/freesewing) - - -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -44,7 +34,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -52,7 +42,7 @@ 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 +## Links 👩‍💻 - 💻 Makers website: [freesewing.org](https://freesewing.org) - 💻 Developers website: [freesewing.dev](https://freesewing.org) @@ -60,3 +50,14 @@ should [become a patron](https://freesewing.org/patrons/join). - 🐦 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). diff --git a/packages/aaron/README.md b/packages/aaron/README.md index f3375160f65..9613ed98922 100644 --- a/packages/aaron/README.md +++ b/packages/aaron/README.md @@ -1,39 +1,49 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/aaron on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/aaron +# @freesewing/aaron A FreeSewing pattern for a A-shirt or tank top -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

- -# freesewing / patterns / aaron - -Aaron is a [freesewing](https://github.com/freesewing/freesewing) pattern -for a tank top / A-shirt. - -See [freesewing.org/patterns/aaron](https://freesewing.org/patterns/aaron) -for more info and examples. - -## Install - -``` -npm i --save @freesewing/aaron -``` -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -54,7 +64,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -62,10 +72,22 @@ 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 +## 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). diff --git a/packages/bent/README.md b/packages/bent/README.md index f81e523dfa2..f449aabafbb 100644 --- a/packages/bent/README.md +++ b/packages/bent/README.md @@ -1,41 +1,49 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/bent on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/bent +# @freesewing/bent A FreeSewing pattern for a menswear body block with a two-part sleeve -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

- -# freesewing / patterns / bent - -Bent is a [freesewing](https://github.com/freesewing/freesewing) pattern -for a body block or sloper with a two-part sleeve. - -It's be basis for our coats and jacket patterns. - -See [freesewing.org/patterns/bent](https://freesewing.org/patterns/bent) -for more info and examples. - -## Install - -``` -npm i --save @freesewing/bent -``` -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -56,7 +64,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -64,10 +72,22 @@ 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 +## 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). diff --git a/packages/brian/README.md b/packages/brian/README.md index 5feb54478d0..2dc87c368e5 100644 --- a/packages/brian/README.md +++ b/packages/brian/README.md @@ -1,46 +1,49 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/brian on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/brian +# @freesewing/brian A FreeSewing pattern for a basic body block for menswear -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

-

- Version - License - Chat on Gitter - Become a Patron -

- -# brian - -Brian is a [freesewing](https://github.com/freesewing/freesewing) pattern -for a basic body block for menswear. It's the basis for many of our menswear patterns. - -See [freesewing.org/patterns/brian](https://freesewing.org/patterns/brian) -for more info and examples. - -## Install - -``` -npm i --save @freesewing/brian -``` - -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -61,7 +64,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -69,10 +72,22 @@ 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 +## 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). diff --git a/packages/bruce/README.md b/packages/bruce/README.md index 0a6ba562086..e9a0cfa158b 100644 --- a/packages/bruce/README.md +++ b/packages/bruce/README.md @@ -1,46 +1,49 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/bruce on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/bruce +# @freesewing/bruce A FreeSewing pattern for boxer briefs -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

-

- Version - License - Chat on Gitter - Become a Patron -

- -# bruce - -Bruce is a [freesewing](https://github.com/freesewing/freesewing) pattern -for a boxer briefs. - -See [freesewing.org/patterns/bruce](https://freesewing.org/patterns/bruce) -for more info and examples. - -## Install - -``` -npm i --save @freesewing/bruce -``` - -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -61,7 +64,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -69,10 +72,22 @@ 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 +## 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). diff --git a/packages/carlita/README.md b/packages/carlita/README.md index 0c55d2adff3..ee62d15edfa 100644 --- a/packages/carlita/README.md +++ b/packages/carlita/README.md @@ -1,46 +1,49 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/carlita on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/carlita +# @freesewing/carlita A FreeSewing pattern for Sherlock Holmes cosplay; Or just a nice long coat -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

-

- Version - License - DeepScan grade - Chat on Gitter - Become a Patron -

- -# freesewing / patterns / carlita - -Carltita is a [freesewing](https://github.com/freesewing/freesewing) pattern -for Sherlock Holmes cosplay, or just a really nice coat. - -See [freesewing.org/patterns/carlita](https://freesewing.org/patterns/carlita) -for more info and examples. - -## Install - -``` -npm i --save @freesewing/carlita -``` -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -61,7 +64,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -69,10 +72,22 @@ 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 +## 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). diff --git a/packages/carlton/README.md b/packages/carlton/README.md index 7fba5ff6088..5677eac99fb 100644 --- a/packages/carlton/README.md +++ b/packages/carlton/README.md @@ -1,46 +1,49 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/carlton on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/carlton +# @freesewing/carlton A FreeSewing pattern for Sherlock Holmes cosplay; Or just a nice long coat -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

-

- Version - License - DeepScan grade - Chat on Gitter - Become a Patron -

- -# freesewing / patterns / carlton - -Carlton is a [freesewing](https://github.com/freesewing/freesewing) pattern -for Sherlock Holmes cosplay, or just a really nice coat. - -See [freesewing.org/patterns/carlton](https://freesewing.org/patterns/carlton) -for more info and examples. - -## Install - -``` -npm i --save @freesewing/carlton -``` -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -61,7 +64,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -69,10 +72,22 @@ 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 +## 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). diff --git a/packages/cathrin/README.md b/packages/cathrin/README.md index 15b76ac6e33..f3439372742 100644 --- a/packages/cathrin/README.md +++ b/packages/cathrin/README.md @@ -1,46 +1,49 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/cathrin on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/cathrin +# @freesewing/cathrin A FreeSewing pattern for a underbust corset / waist trainer -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

-

- Version - License - Chat on Gitter - Become a Patron -

- -# cathrin - -Cathrin is a [freesewing](https://github.com/freesewing/freesewing) pattern -for an underbust corset, aka a waist trainer. - -See [freesewing.org/patterns/cathrin](https://freesewing.org/patterns/cathrin) -for more info and examples. - -## Install - -``` -npm i --save @freesewing/cathrin -``` - -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -61,7 +64,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -69,10 +72,22 @@ 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 +## 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). diff --git a/packages/components/README.md b/packages/components/README.md index 8db87fa7166..8dd6103117f 100644 --- a/packages/components/README.md +++ b/packages/components/README.md @@ -1,76 +1,49 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

- -# @freesewing/components - -A collection of React components for FreeSewing web UIs - -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

-

- Version - License - DeepScan grade - Chat on Gitter - Become a Patron -

+

@freesewing/components on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

# @freesewing/components -This is a [Material UI](https://material-ui.com) theme that's used by the freesewing web sites. +A collection of React components for FreeSewing web UIs -## Install -``` -npm i --save @freesewing/components -``` - -## Getting the theme - -After installing [@freesewing/components](https://www.npmjs.com/package/@freesewing/components), -import it: - -```js -import createTheme from "@freesewing/components"; -``` - -The default export (`createTheme` in our example above) is a method that -calls [`createMuiTheme`](https://material-ui.com/customization/themes/#createmuitheme-options-theme) under the hood. -It takes a single argument, the theme name: - -``` -object createTheme(string themeName = "light") -``` - -If the name you pass it is `dark` you'll get the dark theme. -Anything else, and you'll get the light theme. - -## Using the theme - -To use this theme, you need to pass it as the `theme` prop to -[`muiThemeProvider`](https://material-ui.com/customization/themes/#muithemeprovider): - -```js - - // ... your app here - -``` - -See [the Material-UI docs on themes](https://material-ui.com/customization/themes/) for more details. - - -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -91,7 +64,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -99,10 +72,22 @@ 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 +## 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). diff --git a/packages/core/README.md b/packages/core/README.md index 707fabfc810..a94621983ee 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -1,68 +1,49 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/core on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/core +# @freesewing/core A library for creating made-to-measure sewing patterns -> **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. - -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

-

- Travis build - Version - License - Code coverage - DeepScan grade - Chat on Gitter - Become a Patron -

- -# freesewing - -[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*. - -## Links - - - 💻 Website: [freesewing.org](https://freesewing.org) - - 💬 Chat: [Gitter](https://gitter.im/freesewing/freesewing) - - 🐦 Twitter: [@freesewing_org](https://twitter.com/freesewing_org) - - 📷 Instagram: [@freesewing_org](https://instagram.com/freesewing_org) - -## Features - -- Parametric design of sewing patterns -- Modular design with support for [plugins](https://github.com/freesewing/plugins) -- 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)) -- 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 - -## Getting started - -**@freesewing/core** is a rewrite of [freesewing/core](https://github.com/freesewing/core) in JavaScript. - -It is an ongoing project, and not ready for prime-time yet. Watch this space. -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -83,7 +64,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -91,10 +72,22 @@ 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 +## 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). diff --git a/packages/create-freesewing-pattern/README.md b/packages/create-freesewing-pattern/README.md index 381443072f8..72e507124b7 100644 --- a/packages/create-freesewing-pattern/README.md +++ b/packages/create-freesewing-pattern/README.md @@ -1,11 +1,41 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

create-freesewing-pattern on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

# create-freesewing-pattern @@ -13,7 +43,7 @@ Initializer package for FreeSewing patterns: npm init FreeSewing-pattern -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -34,7 +64,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -42,10 +72,22 @@ 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 +## 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). diff --git a/packages/css-theme/README.md b/packages/css-theme/README.md index 9195f13ef9a..84998ac6613 100644 --- a/packages/css-theme/README.md +++ b/packages/css-theme/README.md @@ -1,21 +1,49 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/css-theme on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/css-theme +# @freesewing/css-theme A CSS theme for FreeSewing web UIs -# css-theme -CSS theme for freesewing web UIs -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -36,7 +64,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -44,10 +72,22 @@ 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 +## 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). diff --git a/packages/examples/README.md b/packages/examples/README.md index 5e99c030663..c0e48ae996e 100644 --- a/packages/examples/README.md +++ b/packages/examples/README.md @@ -1,29 +1,49 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/examples on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/examples +# @freesewing/examples A FreeSewing pattern holding examples for our documentation -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

- -# freesewing examples - -This is a freesewing pattern that holds the examples used in our documentation. -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -44,7 +64,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -52,10 +72,22 @@ 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 +## 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). diff --git a/packages/florent/README.md b/packages/florent/README.md index 0e121ffe7de..915bd4dd81b 100644 --- a/packages/florent/README.md +++ b/packages/florent/README.md @@ -1,46 +1,49 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/florent on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/florent +# @freesewing/florent A FreeSewing pattern for a flat cap -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

-

- Version - License - DeepScan grade - Chat on Gitter - Become a Patron -

- -# freesewing / patterns / florent - -Florent is a [freesewing](https://github.com/freesewing/freesewing) pattern -for a flat cap. - -See [freesewing.org/patterns/florent](https://freesewing.org/patterns/florent) -for more info and examples. - -## Install - -``` -npm i --save @freesewing/florent -``` -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -61,7 +64,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -69,10 +72,22 @@ 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 +## 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). diff --git a/packages/huey/README.md b/packages/huey/README.md index fc7439c3195..40de92bae62 100644 --- a/packages/huey/README.md +++ b/packages/huey/README.md @@ -1,39 +1,49 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/huey on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/huey +# @freesewing/huey A FreeSewing pattern for a zip-up hoodie -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

- -# freesewing / patterns / huey - -Huey is a [freesewing](https://github.com/freesewing/freesewing) pattern -for a zip-up hoodie. - -See [freesewing.org/patterns/huey](https://freesewing.org/patterns/huey) -for more info and examples. - -## Install - -``` -npm i --save @freesewing/huey -``` -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -54,7 +64,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -62,10 +72,22 @@ 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 +## 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). diff --git a/packages/hugo/README.md b/packages/hugo/README.md index f0bb5e7035e..f91499ab63a 100644 --- a/packages/hugo/README.md +++ b/packages/hugo/README.md @@ -1,46 +1,49 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/hugo on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/hugo +# @freesewing/hugo A FreeSewing pattern for a hooded jumper with raglan sleeves -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

-

- Version - License - Chat on Gitter - Become a Patron -

- -# hugo - -Hugo is a [freesewing](https://github.com/freesewing/freesewing) pattern -for a hooded sweater with raglan sleeves. - -See [freesewing.org/patterns/hugo](https://freesewing.org/patterns/hugo) -for more info and examples. - -## Install - -``` -npm i --save @freesewing/hugo -``` - -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -61,7 +64,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -69,10 +72,22 @@ 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 +## 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). diff --git a/packages/i18n/README.md b/packages/i18n/README.md index a0fa64d6df5..52f10f4e77c 100644 --- a/packages/i18n/README.md +++ b/packages/i18n/README.md @@ -1,34 +1,48 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/i18n on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/i18n +# @freesewing/i18n Translations for the FreeSewing project -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

-

- Travis build - Version - License - Code coverage - Chat on Gitter - Become a Patron -

-# i18n - -These are the translation files for the [Freesewing](https://freesewing.org/) project. +# Languages We currently provide translation in 5 languages: @@ -38,13 +52,6 @@ We currently provide translation in 5 languages: - French - Dutch -## Install - -```sh -npm install --save @freesewing/i18n -``` - - ## How to use these translations We use these translations in our [website repository](https://github.com/freesewing/website) to @@ -88,7 +95,7 @@ We also use it in our [backend repository](https://github.com/freesewing/website to translate the emails we send out to users. -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -109,7 +116,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -117,10 +124,22 @@ 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 +## 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). diff --git a/packages/jaeger/README.md b/packages/jaeger/README.md index 1e46db1086d..31168f3d7c4 100644 --- a/packages/jaeger/README.md +++ b/packages/jaeger/README.md @@ -1,46 +1,49 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/jaeger on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/jaeger +# @freesewing/jaeger A FreeSewing pattern for a sport coat style jacket -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

-

- Version - License - DeepScan grade - Chat on Gitter - Become a Patron -

- -# freesewing / patterns / jaeger - -Jaeger is a [freesewing](https://github.com/freesewing/freesewing) pattern -for a sport coat style jacket with two buttons and patch pockets. - -See [freesewing.org/patterns/jaeger](https://freesewing.org/patterns/jaeger) -for more info and examples. - -## Install - -``` -npm i --save @freesewing/jaeger -``` -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -61,7 +64,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -69,10 +72,22 @@ 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 +## 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). diff --git a/packages/models/README.md b/packages/models/README.md index 5bc5914741e..16f651bd6f6 100644 --- a/packages/models/README.md +++ b/packages/models/README.md @@ -1,31 +1,46 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/models on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/models +# @freesewing/models Body measurements data for a range of default sizes -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

- -# Models -A set of body measurement data for a range of standard models/sizes. - -This is used in freesewing for comparing made-to-measure sewing patterns to a range of standard sizes. - -## Install - -npm install --save @freesewing/models ## Usage @@ -56,19 +71,6 @@ The example above gives you: } ``` -In the browser, this will register as `freesewing.models`: - -```html - - - - - -``` - ## Units All measurements are in mm. @@ -82,22 +84,9 @@ All measurements are in mm. - manSize42 - manSize44 -## Build - -To build this, run: - -```sh -npm run build -``` - -## License: MIT - -See [the license file](https://github.com/freesewing/plugin-theme/blob/master/LICENSE) -for details. - -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -118,7 +107,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -126,10 +115,22 @@ 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 +## 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). diff --git a/packages/mui-theme/README.md b/packages/mui-theme/README.md index 4d296279bf2..3a8c1d05fb2 100644 --- a/packages/mui-theme/README.md +++ b/packages/mui-theme/README.md @@ -1,41 +1,47 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

- -# @freesewing/mui-theme - -A Material-UI theme for FreeSewing web UIs - -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

-

- Version - License - DeepScan grade - Chat on Gitter - Become a Patron -

+

@freesewing/mui-theme on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

# @freesewing/mui-theme -This is a [Material UI](https://material-ui.com) theme that's used by the freesewing web sites. +A Material-UI theme for FreeSewing web UIs -## Install - -``` -npm i --save @freesewing/mui-theme -``` - ## Getting the theme After installing [@freesewing/mui-theme](https://www.npmjs.com/package/@freesewing/mui-theme), @@ -70,7 +76,7 @@ To use this theme, you need to pass it as the `theme` prop to See [the Material-UI docs on themes](https://material-ui.com/customization/themes/) for more details. -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -91,7 +97,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -99,10 +105,22 @@ 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 +## 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). diff --git a/packages/pattern-bundle/.editorconfig b/packages/patterns/.editorconfig similarity index 100% rename from packages/pattern-bundle/.editorconfig rename to packages/patterns/.editorconfig diff --git a/packages/pattern-bundle/.gitignore b/packages/patterns/.gitignore similarity index 100% rename from packages/pattern-bundle/.gitignore rename to packages/patterns/.gitignore diff --git a/packages/pattern-bundle/.npmignore b/packages/patterns/.npmignore similarity index 100% rename from packages/pattern-bundle/.npmignore rename to packages/patterns/.npmignore diff --git a/packages/pattern-bundle/README.md b/packages/patterns/README.md similarity index 64% rename from packages/pattern-bundle/README.md rename to packages/patterns/README.md index 51acaebda1b..9647844837d 100644 --- a/packages/pattern-bundle/README.md +++ b/packages/patterns/README.md @@ -1,27 +1,46 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/patterns on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/pattern-bundle +# @freesewing/patterns An umbrella package for all FreeSewing patterns -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

- -# Freesewing patterns - -This bundles the sewing patterns available for (the JavaScript version of) -[freesewing](https://github.com/freesewing/freesewing). ## Included patterns @@ -65,12 +84,6 @@ Blocks or slopers are basic patterns shapes that you can extend into fully detai > > Wear whatever you want, and be proud of the things you make. -## Install - -```sh -npm i --save @freesewing/patterns -``` - ## Usage This exposes 3 named exports: @@ -79,10 +92,9 @@ This exposes 3 named exports: - `patternList` : An array of pattern names - `patternInfo` : Extra pattern information that is typically used for frontend integration (tags, difficulty level, that sort of thing). -For more details, please refer to [the main freesewing library](https://github.com/freesewing/freesewing). -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -103,7 +115,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -111,10 +123,22 @@ 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 +## 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). diff --git a/packages/pattern-bundle/info.md b/packages/patterns/info.md similarity index 100% rename from packages/pattern-bundle/info.md rename to packages/patterns/info.md diff --git a/packages/pattern-bundle/package.json b/packages/patterns/package.json similarity index 82% rename from packages/pattern-bundle/package.json rename to packages/patterns/package.json index 5fd498eab3e..fd8883c0f42 100644 --- a/packages/pattern-bundle/package.json +++ b/packages/patterns/package.json @@ -8,12 +8,14 @@ }, "keywords": [ "freesewing", + "bundle", "design", "diy", "fashion", - "made to measure", + "sewing", + "sewing pattern", "parametric design", - "sewing" + "made to measure" ], "main": "dist/index.js", "module": "dist/index.mjs", @@ -22,7 +24,7 @@ "dependencies": {}, "devDependencies": {}, "files": [ - "../../dist/packages/pattern-bundle/*", + "../../dist/packages/patterns/*", "README.md", "package.json" ], @@ -33,5 +35,5 @@ "node": ">=8.0.0" }, "version": "0.33.0", - "name": "@freesewing/pattern-bundle" + "name": "@freesewing/patterns" } diff --git a/packages/pattern-bundle/rollup.config.js b/packages/patterns/rollup.config.js similarity index 100% rename from packages/pattern-bundle/rollup.config.js rename to packages/patterns/rollup.config.js diff --git a/packages/pattern-bundle/rollup.js b/packages/patterns/rollup.js similarity index 100% rename from packages/pattern-bundle/rollup.js rename to packages/patterns/rollup.js diff --git a/packages/pattern-bundle/src/index.js b/packages/patterns/src/index.js similarity index 100% rename from packages/pattern-bundle/src/index.js rename to packages/patterns/src/index.js diff --git a/packages/pattern-bundle/src/info/aaron.js b/packages/patterns/src/info/aaron.js similarity index 100% rename from packages/pattern-bundle/src/info/aaron.js rename to packages/patterns/src/info/aaron.js diff --git a/packages/pattern-bundle/src/info/bent.js b/packages/patterns/src/info/bent.js similarity index 100% rename from packages/pattern-bundle/src/info/bent.js rename to packages/patterns/src/info/bent.js diff --git a/packages/pattern-bundle/src/info/brian.js b/packages/patterns/src/info/brian.js similarity index 100% rename from packages/pattern-bundle/src/info/brian.js rename to packages/patterns/src/info/brian.js diff --git a/packages/pattern-bundle/src/info/bruce.js b/packages/patterns/src/info/bruce.js similarity index 100% rename from packages/pattern-bundle/src/info/bruce.js rename to packages/patterns/src/info/bruce.js diff --git a/packages/pattern-bundle/src/info/carlton.js b/packages/patterns/src/info/carlton.js similarity index 100% rename from packages/pattern-bundle/src/info/carlton.js rename to packages/patterns/src/info/carlton.js diff --git a/packages/pattern-bundle/src/info/cathrin.js b/packages/patterns/src/info/cathrin.js similarity index 100% rename from packages/pattern-bundle/src/info/cathrin.js rename to packages/patterns/src/info/cathrin.js diff --git a/packages/pattern-bundle/src/info/huey.js b/packages/patterns/src/info/huey.js similarity index 100% rename from packages/pattern-bundle/src/info/huey.js rename to packages/patterns/src/info/huey.js diff --git a/packages/pattern-bundle/src/info/hugo.js b/packages/patterns/src/info/hugo.js similarity index 100% rename from packages/pattern-bundle/src/info/hugo.js rename to packages/patterns/src/info/hugo.js diff --git a/packages/pattern-bundle/src/info/index.js b/packages/patterns/src/info/index.js similarity index 100% rename from packages/pattern-bundle/src/info/index.js rename to packages/patterns/src/info/index.js diff --git a/packages/pattern-bundle/src/info/jaeger.js b/packages/patterns/src/info/jaeger.js similarity index 100% rename from packages/pattern-bundle/src/info/jaeger.js rename to packages/patterns/src/info/jaeger.js diff --git a/packages/pattern-bundle/src/info/simon.js b/packages/patterns/src/info/simon.js similarity index 100% rename from packages/pattern-bundle/src/info/simon.js rename to packages/patterns/src/info/simon.js diff --git a/packages/pattern-bundle/src/info/sven.js b/packages/patterns/src/info/sven.js similarity index 100% rename from packages/pattern-bundle/src/info/sven.js rename to packages/patterns/src/info/sven.js diff --git a/packages/pattern-bundle/src/info/tamiko.js b/packages/patterns/src/info/tamiko.js similarity index 100% rename from packages/pattern-bundle/src/info/tamiko.js rename to packages/patterns/src/info/tamiko.js diff --git a/packages/pattern-bundle/src/info/trayvon.js b/packages/patterns/src/info/trayvon.js similarity index 100% rename from packages/pattern-bundle/src/info/trayvon.js rename to packages/patterns/src/info/trayvon.js diff --git a/packages/pattern-bundle/src/info/wahid.js b/packages/patterns/src/info/wahid.js similarity index 100% rename from packages/pattern-bundle/src/info/wahid.js rename to packages/patterns/src/info/wahid.js diff --git a/packages/pattern-bundle/updateall b/packages/patterns/updateall similarity index 100% rename from packages/pattern-bundle/updateall rename to packages/patterns/updateall diff --git a/packages/plugin-banner/README.md b/packages/plugin-banner/README.md index 376bae4f569..5157c852aa0 100644 --- a/packages/plugin-banner/README.md +++ b/packages/plugin-banner/README.md @@ -1,78 +1,49 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/plugin-banner on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/plugin-banner +# @freesewing/plugin-banner A FreeSewing plugin to repeat text on a path -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

-

- Travis build - Version - License - Code coverage - DeepScan grade - Chat on Gitter - Become a Patron -

- -# plugin-banner - -A freesewing plugin to repeat text on paths. - -## Install - -Install this plugin from NPM: - -```sh -npm install --save @freesewing/plugin-banner -``` - -## Usage - -To load this plugin, add it to your instantiated pattern: - -```js -import pattern from '@freesewing/pattern-brian' -import theme from '@freesewing/plugin-theme' -import banner from '@freesewing/plugin-banner' - -pattern.with(theme).with(banner); -``` - -You now have the `banner` macro available: - -```js -macro("banner", { - path: "hem", - text: [ - "hem", - ": 2x", - "seamAllowance" - ] -}); -``` - -FIXME: Link to documentation - -## Where to get help - -Questions? Stuck? The [freesewing chat room on Gitter](https://gitter.im/freesewing/freesewing) -is the best place to ask for help. -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -93,7 +64,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -101,10 +72,22 @@ 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 +## 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). diff --git a/packages/plugin-bundle/README.md b/packages/plugin-bundle/README.md index 090cde5472e..0ecfd6fdd8a 100644 --- a/packages/plugin-bundle/README.md +++ b/packages/plugin-bundle/README.md @@ -1,36 +1,48 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/plugin-bundle on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/plugin-bundle +# @freesewing/plugin-bundle An umbrella package of 8 essential FreeSewing build-time plugins -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

-

- Travis build - Version - License - Code coverage - DeepScan grade - Chat on Gitter - Become a Patron -

- -# plugin-bundle - -A freesewing plugin that provides the following plugins in one bundle: +# Plugins 1) [plugin-cutonfold](https://github.com/freesewing/plugin-cutonfold) : Add cut-on-fold indicators to your patterns 2) [plugin-dimension](https://github.com/freesewing/plugin-dimension) : Add dimensions to your (paperless) patterns @@ -53,43 +65,14 @@ To load this plugin, add it to your instantiated pattern. On node.js: ```js -import freesewing from 'freesewing' -import pluginBundle from '@freesewing/plugin-bundle' +import freesewing from '@freesewing/core' +import plugins from '@freesewing/plugin-bundle' -let pattern = new freesewing.Pattern() - .with(pluginBundle); -``` - -In the browser, this plugin will register as `freesewing.plugins.bundle`: - -```html - - - - -``` - -## Install - -To install, run: - -```sh -npm install @freesewing/plugin-bundle -``` - -## Build - -To build this plugin, run: - -```sh -npm run build +let pattern = new freesewing.Pattern().with(plugins); ``` -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -110,7 +93,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -118,10 +101,22 @@ 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 +## 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). diff --git a/packages/plugin-bust/README.md b/packages/plugin-bust/README.md index cbad738e78b..5002f1eeba5 100644 --- a/packages/plugin-bust/README.md +++ b/packages/plugin-bust/README.md @@ -1,96 +1,49 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/plugin-bust on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/plugin-bust +# @freesewing/plugin-bust A FreeSewing plugin that helps with bust-adjusting menswear patterns -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

-

- Travis build - Version - License - Code coverage - DeepScan grade - Chat on Gitter - Become a Patron -

- -# plugin-bust - -A freesewing plugin that helps with bust-adjusting menswear pattern. - -> This is a build-time plugin, which means its aimed at pattern designers. - -## Usage - -The goal of this plugin is to make it easier to adapt extended menswear patterns for breasts. - -When adapting a menswear pattern for breasts, you follow the *full-bust-adjustment* approach: - - - Draft the pattern with your *high bust* measurement as *chest circumference* - - Add a bust dart to create room for the full bust measurement - -This plugin helps to accomplish that by: - - - Setting the `fullBust` measurement to the value of the `chestCircumference` measurement - - Setting the `chestCircumference` measurement to the value of the `highBust` measurement - -Now you can extend any freesewing menswear pattern, and it will be drafted with the -`chestCircumference` value replaced with the `highBust`. - -The original chest circumference (full bust) is now available in the `fullBust` measurement. - -> Note: Only when extending menswear patterns -> -> If you are designing a womenswear pattern from scratch, you don't need this. -> You can simply use the measurements of your choice. -> -> This plugin is to be used when you extend a menswear pattern and want to make -> a womenswear version. -## Install - -Install this plugin from NPM: - -```sh -npm install --save @freesewing/plugin-bust -``` - -## Usage - -To load this plugin, load it when instantiating your instantiated pattern: - -```js -import freesewing from 'freesewing' -import plugins from "@freesewing/plugin-bundle"; -import bust from '@freesewing/plugin-bust' - -const Carlita = new freesewing.Design(config, [ - plugins, - bust -]); -``` - -## Where to get help - -Questions? Stuck? The [freesewing chat room on Gitter](https://gitter.im/freesewing/freesewing) -is the best place to ask for help. - - -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -111,7 +64,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -119,10 +72,22 @@ 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 +## 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). diff --git a/packages/plugin-buttons/README.md b/packages/plugin-buttons/README.md index 595b7487850..0c39bd3ac29 100644 --- a/packages/plugin-buttons/README.md +++ b/packages/plugin-buttons/README.md @@ -1,78 +1,49 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/plugin-buttons on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/plugin-buttons +# @freesewing/plugin-buttons A FreeSewing plugin that provides button and buttonhole snippets -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

-

- Travis build - Version - License - Code coverage - DeepScan grade - Chat on Gitter - Become a Patron -

- -# plugin-buttons - -A freesewing plugin that provides button and buttonhole snippets. - -## Install - -Install this plugin from NPM: - -```sh -npm install --save @freesewing/plugin-buttons -``` - -## Usage - -To load this plugin, add it to your instantiated pattern: - -```js -import freesewing from 'freesewing' -import buttons from '@freesewing/plugin-buttons' - -const Simon = function(settings) { - freesewing.Pattern.call(this, config); - this - .use(buttons) - .apply(settings); - - return this; -} -``` - -You now have the `button` and `buttonhole` snippets available: - -```js -snippets.btn = new Snippet("button", points.buttonAnchor); -snippets.btnhole = new Snippet("buttonhole", points.buttonholeAnchor); -``` - -FIXME: Link to documentation - -## Where to get help - -Questions? Stuck? The [freesewing chat room on Gitter](https://gitter.im/freesewing/freesewing) -is the best place to ask for help. -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -93,7 +64,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -101,10 +72,22 @@ 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 +## 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). diff --git a/packages/plugin-cutonfold/README.md b/packages/plugin-cutonfold/README.md index 504ca0925dc..fbdf307c57c 100644 --- a/packages/plugin-cutonfold/README.md +++ b/packages/plugin-cutonfold/README.md @@ -1,119 +1,49 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/plugin-cutonfold on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/plugin-cutonfold +# @freesewing/plugin-cutonfold A FreeSewing plugin to add cut-on-fold indicators on your patterns -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

-

- Travis build - Version - License - Code coverage - DeepScan grade - Chat on Gitter - Become a Patron -

- -# plugin-cutonfold - -A freesewing plugin to add cut-on-fold indicators to your patterns. - -## Install - -On node.js: - -```sh -npm install @freesewing/plugin-cutonfold -``` - -in the browser, simply include this script: - -```html - -``` - -## Loading this plugin - -To load this plugin, add it to your instantiated pattern. - -On node.js: - -```js -import pattern from '@freesewing/pattern-brian' -import cutonfold from '@freesewing/plugin-cutonfold' - -pattern.with(cutonfold); -``` - -In the browser, this plugin will register as `freesewing.plugins.cutonfold`. -Since it's a build-time plugin, it will be loaded by the pattern. - -```html - - - - - -``` - -## Usage - -This plugin provides the `cutonfold` macro. - -> The macro method is available from the `shorthand()` method on an instantiated pattern part. - -```js -macro('cutonfold', { - from: points.cbNeck, - to: points.cbHips -}); - ``` - -### Parameters - - - `to`: A point object at the start of the cut-on-fold indicator - - `from`: A point object at the end of the cut-on-fold indicator - - `offset`: Distance in mm that the cut-on-fold line is offset from the line between `from` and `to`. Default: 50mm. - - `margin`: Percentange the cut-on-fold line will remain from the `from` and `to` points. Default: 5%. - - `grainline`: Whether this is also the grainline. Default: `false` - -As all freesewing macros, bundle these parameters into a single object. - -## Example - -![Example of the output provided by this plugin](https://github.com/freesewing/plugin-cutonfold/raw/master/img/example.png) -## Build - -To build this plugin, run: - -```sh -npm run build -``` - -## License: MIT - -See [the license file](https://github.com/freesewing/plugin-theme/blob/master/LICENSE) -for details. - - -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -134,7 +64,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -142,10 +72,22 @@ 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 +## 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). diff --git a/packages/plugin-debug/README.md b/packages/plugin-debug/README.md index 7528638aa87..eb10fb31d0e 100644 --- a/packages/plugin-debug/README.md +++ b/packages/plugin-debug/README.md @@ -1,85 +1,49 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/plugin-debug on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/plugin-debug +# @freesewing/plugin-debug A FreeSewing plugin to log debug info to your browser console -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

-

- Travis build - Version - License - Code coverage - DeepScan grade - Chat on Gitter - Become a Patron -

- -# plugin-debug - -A freesewing plugin to log debug information to the console. - -## Usage - -To load this plugin, add it to your instantiated pattern. - -On node.js: - -```js -import pattern from '@freesewing/pattern-brian' -import debug from '@freesewing/plugin-debug' - -pattern.with(debug); -``` - -In the browser, this plugin will register as `freesewing.plugins.debug`: - -```html - - - - - -``` - -## Install - -To install, run: - -```sh -npm install @freesewing/plugin-debug -``` - -## Build - -To build this plugin, run: - -```sh -npm run build -``` - -## License: MIT - -See [the license file](https://github.com/freesewing/plugin-theme/blob/master/LICENSE) -for details. -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -100,7 +64,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -108,10 +72,22 @@ 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 +## 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). diff --git a/packages/plugin-designer/README.md b/packages/plugin-designer/README.md index 659c1268a45..bfcdde08f2b 100644 --- a/packages/plugin-designer/README.md +++ b/packages/plugin-designer/README.md @@ -1,93 +1,49 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/plugin-designer on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/plugin-designer +# @freesewing/plugin-designer A FreeSewing plugin to facilitate pattern design -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

-

- Travis build - Version - License - Code coverage - DeepScan grade - Chat on Gitter - Become a Patron -

- -# plugin-designer - -A freesewing plugin to facilitate pattern design. - -This plugin will add markers to your pattern for all points, it will illustrate -Bezier curve handlers, and inject JavaScript -to log information about points to the browser console when your hover over them. - -In addition, it will log the entire pattern object to the console so you can inspect it. - -If you want to design patterns, you may want to use this plugin while doing so. - -## Install - -On node.js: - -```sh -npm install @freesewing/plugin-designer -``` - -in the browser, simply include this script: - -```html - -``` - -## Loading this plugin - -To load this plugin, add it to your instantiated pattern. - -On node.js: - -```js -import pattern from "@freesewing/pattern-brian" -import designer from "@freesewing/plugin-designer" - -pattern.with(designer); -``` - -In the browser, this plugin will register as `freesewing.plugins.designer`. - -Since it's a run-time plugin, you need to load it into your pattern: - -```html - - - - - -``` - -## License: MIT - -See [the license file](https://github.com/freesewing/plugin-designer/blob/master/LICENSE) -for details. -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -108,7 +64,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -116,10 +72,22 @@ 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 +## 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). diff --git a/packages/plugin-dimension/README.md b/packages/plugin-dimension/README.md index 0066bfa0182..8d908ee072e 100644 --- a/packages/plugin-dimension/README.md +++ b/packages/plugin-dimension/README.md @@ -1,145 +1,49 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/plugin-dimension on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/plugin-dimension +# @freesewing/plugin-dimension A FreeSewing plugin to add dimensions to your (paperless) pattern -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

-

- Travis build - Version - License - Code coverage - DeepScan grade - Chat on Gitter - Become a Patron -

- -# plugin-dimension - -A [freesewing](https://github.com/freesewing/freesewing) -plugin to add dimensions to your (paperless) patterns. - -## Install - -Install this plugin from NPM: - -```sh -npm install @freesewing/plugins-dimension --save -``` - -## Loading the plugin - -To load this plugin, add it to your instantiated pattern: - -```js -import pattern from '@freesewing/pattern-brian' -import theme from '@freesewing/plugin-theme' -import dimension from '@freesewing/plugin-dimension' - -pattern.with(theme).with(dimension); -``` - -You now have the following macros available: - -Name | Description -----------|----------------------------------------------------- -`hd` | Adds a horizontal dimension -`vd` | Adds a vertical dimension -`ld` | Adds a linear dimension -`pd` | Adds a dimension that follows a path - -You can use them as such: - -```sh -macro('', {}); -``` - -## Parameters - -As all freesewing plugins, all options needs to be passed as a single object. - -### hd - -```js -part.macro('hd', { - from: points.cbNeck -, to: points.cbHips, - y: points.cbHips + 15 -}); -``` - - `from` : A point object - - `to` : A point object - - `y` : The y-value at which to place the dimension - -### vd - -```js -part.macro('vd', { - from: points.cbNeck -, to: points.cbHips, - x: points.cbHips + 15 -}); -``` - - `from` : A point object - - `to` : A point object - - `x` : The x-value at which to place the dimension - -As all freesewing macros, bundle these parameters into a single object. - -### ld - -```js -part.macro('ld', { - from: points.cbNeck -, to: points.cbHips, - d: 15 -}); -``` - - `from` : A point object - - `to` : A point object - - `d` : The distance by which to offset the dimension from the line between from and to - -As all freesewing macros, bundle these parameters into a single object. - -### pd - -```js -part.macro('pd', { - path: new path().move(points.cbNeck).curve(points.cbNeckCp1, points.cbNeckCp2, points.cbHips), - d: 15 -}); -``` - - `path` : A path object - - `d` : The distance by which to offset the dimension from the path - -As all freesewing macros, bundle these parameters into a single object. - -## Example - -Below is an example of different dimensions. - -![Example of the dimension plugin](https://github.com/freesewing/plugin-dimension/raw/master/img/example.png) - -## Where to get help - -Questions? Stuck? The [freesewing chat room on Gitter](https://gitter.im/freesewing/freesewing) -is the best place to ask for help. -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -160,7 +64,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -168,10 +72,22 @@ 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 +## 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). diff --git a/packages/plugin-flip/README.md b/packages/plugin-flip/README.md index c60c8cf9107..2d91d883bc6 100644 --- a/packages/plugin-flip/README.md +++ b/packages/plugin-flip/README.md @@ -1,75 +1,49 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/plugin-flip on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/plugin-flip +# @freesewing/plugin-flip A FreeSewing plugin to flip parts horizontally -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

-

- Travis build - Version - License - Code coverage - DeepScan grade - Chat on Gitter - Become a Patron -

- -# plugin-flip - -A freesewing plugin to flip a part around the Y-axis (mirror it horizontally). - -## Install - -Install this plugin from NPM: - -```sh -npm install --save @freesewing/plugin-flip -``` - -## Usage - -To load this plugin, add it to your instantiated pattern: - -```js -import pattern from '@freesewing/pattern-brian' -import theme from '@freesewing/plugin-theme' -import flip from '@freesewing/plugin-flip' - -pattern.with(theme).with(flip); -``` - -You now have the `flip` macro available: - -```js -macro("flip"); -``` - -This macro will: - - - For all the points in your part, it will multiply their X-value by -1 - - For all the snippets in your part, it will multiply the X-value of their anchor point by -1 - - For all the paths in your part, and for each point the path uses, it will multiply its X-value by -1 - -## Where to get help - -Questions? Stuck? The [freesewing chat room on Gitter](https://gitter.im/freesewing/freesewing) -is the best place to ask for help. -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -90,7 +64,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -98,10 +72,22 @@ 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 +## 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). diff --git a/packages/plugin-grainline/README.md b/packages/plugin-grainline/README.md index c5c84c61e74..92d42ceeafb 100644 --- a/packages/plugin-grainline/README.md +++ b/packages/plugin-grainline/README.md @@ -1,117 +1,49 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/plugin-grainline on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/plugin-grainline +# @freesewing/plugin-grainline A FreeSewing plugin to add grainline indicators on your patterns -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

-

- Travis build - Version - License - Code coverage - DeepScan grade - Chat on Gitter - Become a Patron -

-# plugin-grainline - -A freesewing plugin to add grainline indicators to your patterns. - -## Install - -On node.js: - -```sh -npm install @freesewing/plugin-grainline -``` - -in the browser, simply include this script: - -```html - -``` - -## Loading this plugin - -To load this plugin, add it to your instantiated pattern. - -On node.js: - -```js -import pattern from '@freesewing/pattern-brian' -import grainline from '@freesewing/plugin-grainline' - -pattern.with(grainline); -``` - -In the browser, this plugin will register as `freesewing.plugins.grainline`. -Since it's a build-time plugin, it will be loaded by the pattern. - -```html - - - - - -``` - -## Usage - -This plugin provides the `grainline` macro. - -> The macro method is available from the `shorthand()` method on an instantiated pattern part. - -```js -macro('grainline', { - from: points.cbNeck - , to: points.cbHips -}); - ``` - -### Parameters - - - `to`: A point object at the start of the grainline indicator - - `from`: A point object at the end of the grainline indicator - -As all freesewing macros, bundle these parameters into a single object. - -## Example - -![Example of the output provided by this plugin](https://github.com/freesewing/plugin-grainline/raw/master/img/example.png) - - -## Build - -To build this plugin, run: - -```sh -npm run build -``` - -## License: MIT - -See [the license file](https://github.com/freesewing/plugin-theme/blob/master/LICENSE) -for details. - - -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -132,7 +64,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -140,10 +72,22 @@ 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 +## 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). diff --git a/packages/plugin-i18n/README.md b/packages/plugin-i18n/README.md index 5c38b8ec808..09e1091cb8f 100644 --- a/packages/plugin-i18n/README.md +++ b/packages/plugin-i18n/README.md @@ -1,87 +1,49 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/plugin-i18n on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/plugin-i18n +# @freesewing/plugin-i18n A FreeSewing plugin for pattern translation -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

-

- Travis build - Version - License - Code coverage - DeepScan grade - Chat on Gitter - Become a Patron -

-# plugin-i18n - -A freesewing plugin to provide translation to your patterns. - -## Install - -On node.js: - -```sh -npm install @freesewing/plugin-i18n -``` - -in the browser, simply include the plugin from unpkg: - -```html - -``` -This plugin will register as `freesewing.plugins.i18n`. - -## Loading this plugin and providing translation data - -This plugin does not come with translations. You should provide the translations -when registering the plugin. - -Perhaps you want to use your own translations, or you can use ours from the -[@freesewing/i18n](https://www.npmjs.com/package/@freesewing/i18n) package. -Note that if you use ours, you only need to add the `plugin` export: - -```js -import brian from '@freesewing/brian'; -import i18nPlugin from '@freesewing/plugin-grainline'; -import { plugin } from '@freesewing/i18n'; - -const pattern = new Brian().with(i18nPlugin, { - prefix: "plugin.", - strings: plugin -}); -``` - -## Build - -To build this plugin, run: - -```sh -npm run build -``` - -## License: MIT - -See [the license file](https://github.com/freesewing/plugin-theme/blob/master/LICENSE) -for details. - - -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -102,7 +64,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -110,10 +72,22 @@ 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 +## 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). diff --git a/packages/plugin-logo/README.md b/packages/plugin-logo/README.md index a28a545fcaf..500c222f00e 100644 --- a/packages/plugin-logo/README.md +++ b/packages/plugin-logo/README.md @@ -1,80 +1,49 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/plugin-logo on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/plugin-logo +# @freesewing/plugin-logo A FreeSewing plugin to add our logo to your patterns -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

-

- Travis build - Version - License - Code coverage - DeepScan grade - Chat on Gitter - Become a Patron -

- -# plugin-logo - -A freesewing plugin to add our logo to your pattern. - -## Install - -Install this plugin from NPM: - -```sh -npm install --save @freesewing/plugin-logo -``` - -## Usage - -To load this plugin, add it to your instantiated pattern: - -```js -import pattern from '@freesewing/pattern-brian' -import theme from '@freesewing/plugin-theme' -import logo from '@freesewing/plugin-logo' - -pattern.with(theme).with(logo); -``` - -You now have the `logo` snippet available: - -```js -snippets.logo = new Snippet('logo', points.logo); -``` - -**Good to know:** - - - The logo's anchor point is it's chin - - Like any snippet, you can scale the logo by setting the `data-scale` attribbute on the snippet: - -```js -snippets.logo = new Snippet('logo', points.logo) - .attr('data-scale', 2); // Make it twice as big -``` -## Where to get help - -Questions? Stuck? The [freesewing chat room on Gitter](https://gitter.im/freesewing/freesewing) -is the best place to ask for help. - - -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -95,7 +64,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -103,10 +72,22 @@ 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 +## 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). diff --git a/packages/plugin-round/README.md b/packages/plugin-round/README.md index cf4cdcb54ab..1882d65d342 100644 --- a/packages/plugin-round/README.md +++ b/packages/plugin-round/README.md @@ -1,79 +1,49 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/plugin-round on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/plugin-round +# @freesewing/plugin-round A FreeSewing plugin to round corners -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

-

- Travis build - Version - License - Code coverage - DeepScan grade - Chat on Gitter - Become a Patron -

- -# plugin-round - -A freesewing plugin to round corners. - -## Install - -Install this plugin from NPM: - -```sh -npm install --save @freesewing/plugin-round -``` - -## Usage - -To load this plugin, add it to your instantiated pattern: - -```js -import pattern from '@freesewing/pattern-brian' -import theme from '@freesewing/plugin-theme' -import round from '@freesewing/plugin-round' - -pattern.with(theme).with(round); -``` - -You now have the `round` macro available: - -```js -macro("round", { - from: pointA, - to: pointC, - via: pointB, - radius: 20, - render: true, - class: "fabric", - prefix: "example" -}); -``` - -FIXME: Link to documentation - -## Where to get help - -Questions? Stuck? The [freesewing chat room on Gitter](https://gitter.im/freesewing/freesewing) -is the best place to ask for help. -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -94,7 +64,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -102,10 +72,22 @@ 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 +## 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). diff --git a/packages/plugin-scalebox/README.md b/packages/plugin-scalebox/README.md index 4a42ebcabff..a7c94fc67f2 100644 --- a/packages/plugin-scalebox/README.md +++ b/packages/plugin-scalebox/README.md @@ -1,114 +1,49 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/plugin-scalebox on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/plugin-scalebox +# @freesewing/plugin-scalebox A FreeSewing plugin to add a scalebox to your pattern -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

-

- Travis build - Version - License - Code coverage - DeepScan grade - Chat on Gitter - Become a Patron -

- -# plugin-scalebox - -A freesewing plugin to add a scalebox to your pattern. - -## Usage - -To load this plugin, add it to your instantiated pattern. - -On node.js: - -```js -import freesewing from 'freesewing' -import scalebox from '@freesewing/plugin-scalebox' - -let pattern = new freesewing.Pattern() - .with(scalebox); -``` - -In the browser, this plugin will register as `freesewing.plugins.scalebox`: - -```html - - - - -``` - -You can now use the **scalebox** macro as such: - -```js -macro('scalebox', { - at: new Point(0,0), - lead: 'This is the lead', - title: 'This is the title', - text: "And this is the text\nwhich has room for a few lines should you\nfeel so inclined" -}); -``` - -## Configuration - -The macro configuration object takes the following properties: - -Name | Description | Default ----------|---------------------------------------------|------------------- -`at` | A Point object to anchor the scalebox on | -`lead` | The lead text | freesewing -`title` | The lead text | pattern name & version -`text` | The lead text | *See example below* -## Example - -This plugin provides the **scalebox** macro that inserts a scalebox like this: - -![Example of the scalebox inserted by this plugin](https://github.com/freesewing/plugin-scalebox/raw/master/img/example.png) - -These are the default values. The example under Usage above would render like this: - -![Example of the scalebox inserted by this plugin](https://github.com/freesewing/plugin-scalebox/raw/master/img/custom.png) - -## Install - -To install, run: - -```sh -npm install @freesewing/plugin-scalebox -``` - -## Build - -To build this plugin, run: - -```sh -npm run build -``` - - - -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -129,7 +64,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -137,10 +72,22 @@ 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 +## 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). diff --git a/packages/plugin-sprinkle/README.md b/packages/plugin-sprinkle/README.md index 227edc96092..270dd707d94 100644 --- a/packages/plugin-sprinkle/README.md +++ b/packages/plugin-sprinkle/README.md @@ -1,82 +1,49 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/plugin-sprinkle on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/plugin-sprinkle +# @freesewing/plugin-sprinkle A FreeSewing plugin to bulk-add snippets to your pattern -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

-

- Travis build - Version - License - Code coverage - DeepScan grade - Chat on Gitter - Become a Patron -

- -# plugin-sprinkle - -A freesewing plugin to bulk-add multiple snippets to your pattern. - -Typically used to add a bunch of notches, buttons, and so on. - -## Install - -Install this plugin from NPM: - -```sh -npm install --save @freesewing/plugin-sprinkle -``` - -## Usage - -To load this plugin, add it to your instantiated pattern: - -```js -import freesewing from 'freesewing' -import sprinkle from '@freesewing/plugin-sprinkle' - -const Simon = function(settings) { - freesewing.Pattern.call(this, config); - this - .use(sprinkle) - .apply(settings); - - return this; -} -``` - -You now have the `sprinkle` macro available: - -```js -macro("sprinkle", { - snippet: "notch", - on: ["pointA", "pointB", "pointC"] -}); -``` - -FIXME: Link to documentation - -## Where to get help - -Questions? Stuck? The [freesewing chat room on Gitter](https://gitter.im/freesewing/freesewing) -is the best place to ask for help. -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -97,7 +64,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -105,10 +72,22 @@ 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 +## 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). diff --git a/packages/plugin-svgattr/README.md b/packages/plugin-svgattr/README.md index 15e4e5a3df0..484ea3e18f1 100644 --- a/packages/plugin-svgattr/README.md +++ b/packages/plugin-svgattr/README.md @@ -1,68 +1,49 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/plugin-svgattr on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/plugin-svgattr +# @freesewing/plugin-svgattr A FreeSewing plugin to set SVG attributes -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

-

- Travis build - Version - License - Code coverage - DeepScan grade - Chat on Gitter - Become a Patron -

- -# plugin-svgattr - -A freesewing plugin to add attributes to the SVG tag of a rendered pattern. -Typically used to add CSS classes or an ID to the SVG to allow styling. - -## Links - - - 📕 Documentation: [developer.freesewing.org/plugins/#svgattr](https://developer.freesewing.org/plugins/#svgattr) - - 📂 Source code: [gitub.com/freesewing/plugin-svgattr](https:/github.co/freesewing/plugin-svgattr) - - 📦 NPM Package: [@freesewing/plugin-svgattr](https://www.npmjs.com/package/@freesewing/plugin-svgattr) - - 💻 Website: [freesewing.org](https://freesewing.org) - - 💬 Chat: [Gitter](https://gitter.im/freesewing/freesewing) - - 🐦 Twitter: [@freesewing_org](https://twitter.com/freesewing_org) - - 📷 Instagram: [@freesewing_org](https://instagram.com/freesewing_org) - -## Install - -```sh -npm install @freesewing/plugin-svgattr -``` - -## Usage - -```js -import brian from '@freesewing/brian' -import svgattr from '@freesewing/plugin-svgattr' - -let pattern = new brian - .with(svgattr, {id: "someid", class: "class1 another-class"}); -``` - -More details are are available at -[developer.freesewing.org/plugins](https://developer.freesewing.org/plugins/) -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -83,7 +64,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -91,10 +72,22 @@ 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 +## 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). diff --git a/packages/plugin-theme/README.md b/packages/plugin-theme/README.md index 021a55a474a..7290e2aa6c3 100644 --- a/packages/plugin-theme/README.md +++ b/packages/plugin-theme/README.md @@ -1,77 +1,49 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/plugin-theme on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/plugin-theme +# @freesewing/plugin-theme A FreeSewing plugin that provides a default theme -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

-

- Travis build - Version - License - Code coverage - DeepScan grade - Chat on Gitter - Become a Patron -

- -# plugin-theme - -A freesewing plugin that styles your patterns. This plugin also provides the `notch` and `bnotch` snippets. - -## Usage - -To load this plugin, add it to your instantiated pattern. - -On node.js: - -```js -import pattern from '@freesewing/pattern-brian' -import theme from '@freesewing/plugin-theme' - -pattern.with(theme); -``` - -In the browser, this plugin will register as `freesewing.plugins.theme`: - -```html - - - - - -``` - -## Install - -To install, run: - -```sh -npm install @freesewing/plugin-theme -``` - -## License: MIT - -See [the license file](https://github.com/freesewing/plugin-theme/blob/master/LICENSE) -for details. -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -92,7 +64,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -100,10 +72,22 @@ 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 +## 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). diff --git a/packages/plugin-title/README.md b/packages/plugin-title/README.md index 3e823646054..5effa855f9b 100644 --- a/packages/plugin-title/README.md +++ b/packages/plugin-title/README.md @@ -1,94 +1,49 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/plugin-title on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/plugin-title +# @freesewing/plugin-title A FreeSewing plugin to add a title to your pattern parts -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

-

- Travis build - Version - License - Code coverage - DeepScan grade - Chat on Gitter - Become a Patron -

- -# plugin-title - -A freesewing plugin to add pretty part titles to your pattern. - -## Usage - -To load this plugin, add it to your instantiated pattern. - -On node.js: - -```js -import pattern from '@freesewing/pattern-brian' -import title from '@freesewing/plugin-theme' -import title from '@freesewing/plugin-title' - -pattern..with(theme).with(title); -``` - -In the browser, this plugin will register as `freesewing.plugins.title`: - -```html - - - - - - -``` - -## Example - -This plugin styles a title like this: - -![Example of the title inserted by this plugin](https://github.com/freesewing/plugin-title/raw/master/img/example.png) - -## Install - -To install, run: - -```sh -npm install @freesewing/plugin-title -``` - -## Build - -To build this plugin, run: - -```sh -npm run build -``` - -## License: MIT - -See [the license file](https://github.com/freesewing/plugin-theme/blob/master/LICENSE) -for details. -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -109,7 +64,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -117,10 +72,22 @@ 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 +## 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). diff --git a/packages/plugin-validate/README.md b/packages/plugin-validate/README.md index d045402b798..0f7d9189df4 100644 --- a/packages/plugin-validate/README.md +++ b/packages/plugin-validate/README.md @@ -1,88 +1,49 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/plugin-validate on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/plugin-validate +# @freesewing/plugin-validate A FreeSewing plugin that validates aspects of your code -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

-

- Travis build - Version - License - Code coverage - DeepScan grade - Chat on Gitter - Become a Patron -

- -# plugin-validate - -A freesewing plugin that validates your pattern and input. It will check for: - - - Missing measurements that are required by the pattern - - Missing X or Y coordinates in points - - Points that aren't points or don't have proper attributes - - Paths that don't do anything (no ops) - - Paths that use points that aren't valid points - - Text that will cause problems for translation - -On any of these, this plugin will throw an error. -As such, it's not meant to be used in production, but rather during pattern -development, to spot issues in your code. - -## Usage - -To load this plugin, add it to your instantiated pattern. - -On node.js: - -```js -import pattern from '@freesewing/pattern-brian' -import validate from '@freesewing/plugin-validate' - -pattern.with(validate); -``` - -In the browser, this plugin will register as `freesewing.plugins.validate`: - -```html - - - - - -``` - -## Install - -To install, run: - -```sh -npm install @freesewing/plugin-validate -``` - -## License: MIT - -See [the license file](https://github.com/freesewing/plugin-validate/blob/master/LICENSE) -for details. -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -103,7 +64,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -111,10 +72,22 @@ 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 +## 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). diff --git a/packages/shin/README.md b/packages/shin/README.md index 164092e7465..554ff70e0db 100644 --- a/packages/shin/README.md +++ b/packages/shin/README.md @@ -1,39 +1,49 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/shin on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/shin +# @freesewing/shin A FreeSewing pattern for swim trunks -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

- -# freesewing / patterns / shin - -Shin is a [freesewing](https://github.com/freesewing/freesewing) pattern -for swim trunks. - -See [freesewing.org/patterns/shin](https://freesewing.org/patterns/huey) -for more info and examples. - -## Install - -``` -npm i --save @freesewing/shin -``` -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -54,7 +64,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -62,10 +72,22 @@ 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 +## 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). diff --git a/packages/simon/README.md b/packages/simon/README.md index c2b72b811af..a5f2ef07678 100644 --- a/packages/simon/README.md +++ b/packages/simon/README.md @@ -1,46 +1,49 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/simon on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/simon +# @freesewing/simon A FreeSewing pattern for a button down shirt -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

-

- Version - License - Chat on Gitter - Become a Patron -

- -# simon - -Simon is a [freesewing](https://github.com/freesewing/freesewing) pattern -for a button-down shirt. - -See [freesewing.org/patterns/simon](https://freesewing.org/patterns/simon) -for more info and examples. - -## Install - -``` -npm i --save @freesewing/simon -``` - -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -61,7 +64,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -69,10 +72,22 @@ 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 +## 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). diff --git a/packages/sven/README.md b/packages/sven/README.md index 96b31aa12f7..7ae0509866e 100644 --- a/packages/sven/README.md +++ b/packages/sven/README.md @@ -1,46 +1,49 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/sven on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/sven +# @freesewing/sven A FreeSewing pattern for a straightforward sweater -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

-

- Version - License - Chat on Gitter - Become a Patron -

- -# sven - -Sven is a [freesewing](https://github.com/freesewing/freesewing) pattern -for a straightforward sweater. - -See [freesewing.org/patterns/sven](https://freesewing.org/patterns/sven) -for more info and examples. - -## Install - -``` -npm i --save @freesewing/sven -``` - -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -61,7 +64,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -69,10 +72,22 @@ 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 +## 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). diff --git a/packages/tamiko/README.md b/packages/tamiko/README.md index 1623746a2a9..7c0e49ab614 100644 --- a/packages/tamiko/README.md +++ b/packages/tamiko/README.md @@ -1,39 +1,49 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/tamiko on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/tamiko +# @freesewing/tamiko A FreeSewing pattern for a zero-waste top -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

- -# freesewing / patterns / tamiko - -Tamiko is a [freesewing](https://github.com/freesewing/freesewing) pattern -for a zero-waste top. - -See [freesewing.org/patterns/tamiko](https://freesewing.org/patterns/tamiko) -for more info and examples. - -## Install - -``` -npm i --save @freesewing/tamiko -``` -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -54,7 +64,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -62,10 +72,22 @@ 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 +## 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). diff --git a/packages/trayvon/README.md b/packages/trayvon/README.md index e358c6f8732..ab09abe76f9 100644 --- a/packages/trayvon/README.md +++ b/packages/trayvon/README.md @@ -1,39 +1,49 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/trayvon on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/trayvon +# @freesewing/trayvon A FreeSewing pattern for a tie -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

- -# freesewing / patterns / trayvon - -Trayvon is a [freesewing](https://github.com/freesewing/freesewing) pattern -for a neck tie. - -See [freesewing.org/patterns/trayvon](https://freesewing.org/patterns/trayvon) -for more info and examples. - -## Install - -``` -npm i --save @freesewing/trayvon -``` -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -54,7 +64,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -62,10 +72,22 @@ 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 +## 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). diff --git a/packages/wahid/README.md b/packages/wahid/README.md index a8541c31f22..3b40b5634d3 100644 --- a/packages/wahid/README.md +++ b/packages/wahid/README.md @@ -1,39 +1,49 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/wahid on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/wahid +# @freesewing/wahid A FreeSewing pattern for a classic fitted waistcoat -

- Freesewing logo -

-

 freesewing -
a library for made-to-measure sewing patterns -

- -# freesewing / patterns / wahid - -Wahid is a [freesewing](https://github.com/freesewing/freesewing) pattern -for a classic fitted waistcoat. - -See [freesewing.org/patterns/wahid](https://freesewing.org/patterns/wahid) -for more info and examples. - -## Install - -``` -npm i --save @freesewing/wahid -``` -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -54,7 +64,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -62,10 +72,22 @@ 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 +## 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). diff --git a/packages/workbench/README.md b/packages/workbench/README.md index 831f3728b60..cc06ab698ab 100644 --- a/packages/workbench/README.md +++ b/packages/workbench/README.md @@ -1,50 +1,49 @@ > **Note**: This is part of version 2 of FreeSewing. > It is a work in progress, and not ready for prime-time yet > -> For all questions, please come say hellp in [our chatroom on Gitter](https://gitter.im/). +> For all questions, please come say hello in [our chatroom on Gitter](https://gitter.im/).

Freesewing logo

FreeSewing is a free and open source library for made-to-measure sewing patterns

-

Chat with us on GitterFollow @freesewing_org on TwitterFreeSewing on GitHubBecome a FreeSewing PatronLicense: MITBecome a FreeSewing PatronFreeSewing.orgFreeSewing.dev

+

@freesewing/workbench on NPM + License: MIT +

Chat with us on Gitter + Follow @freesewing_org on Twitter + FreeSewing on GitHub + Become a FreeSewing Patron +

-# @freesewing/workbench +# @freesewing/workbench A React component to facilitate FreeSewing pattern design -# workbench - -> A React component to facilitate freesewing pattern design - -[![NPM](https://img.shields.io/npm/v/workbench.svg)](https://www.npmjs.com/package/workbench) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com) - -## Install - -```bash -npm install --save workbench -``` - -## Usage - -```jsx -import React, { Component } from 'react' - -import MyComponent from 'workbench' - -class Example extends Component { - render () { - return ( - - ) - } -} -``` - -## License - -MIT © [freesewing](https://github.com/freesewing) -## About FreeSewing +## About FreeSewing 🤔 Where the world of makers and developers collide, that's where you'll find FreeSewing. @@ -65,7 +64,7 @@ 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 ♥️ +## Support FreeSewing: Become a patron 🥰 FreeSewing is an open source project run by a community, and financially supported by our patrons. @@ -73,10 +72,22 @@ 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 +## 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). diff --git a/scripts/reconfigure.js b/scripts/reconfigure.js index b0ae8610661..2d8ece6736a 100644 --- a/scripts/reconfigure.js +++ b/scripts/reconfigure.js @@ -192,16 +192,28 @@ function packageConfig(pkg, config) { */ function badges(pkg, config) { let markup = ""; - for (let key of Object.keys(config.badges._all)) { - let b = config.badges._all[key]; - markup += `${ - b.alt - }`; + for (let group of ["_all", "_social"]) { + markup += "

"; + for (let key of Object.keys(config.badges[group])) { + markup += formatBadge(config.badges[group][key], fullName(pkg, config)); + } + markup += "

"; } return markup; } +/** + * Formats a badge for a readme file + */ +function formatBadge(badge, fullname) { + return `${Mustache.render(badge.alt, { fullname })} + `; +} /** * Returns the full (namespaced) name of a package */