Joost De Cock 1fd46554af 🔧 Switched to centrally managed README files

2019-04-19 20:09:30 +02:00

5.6 KiB

Raw Blame History

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.

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

@freesewing/plugin-banner

A FreeSewing plugin to repeat text on a path

freesewing
^{a library for made-to-measure sewing patterns}

plugin-banner

A freesewing plugin to repeat text on paths.

Install

Install this plugin from NPM:

npm install --save @freesewing/plugin-banner

Usage

To load this plugin, add it to your instantiated pattern:

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:

macro("banner", {
  path: "hem",
  text: [
    "hem",
    ": 2x",
    "seamAllowance"
  ]
});

FIXME: Link to documentation

Where to get help

Questions? Stuck? The freesewing chat room on Gitter is the best place to ask for help.

About FreeSewing

Where the world of makers and developers collide, that's where you'll find FreeSewing.

Our core library is a batteries-included toolbox for parametric design of sewing patterns. It's a modular system (check our list of plugins and getting started is as simple as:

npm init freesewing-pattern

The [getting started] section on freesewing.dev is a good entrypoint to our documentation, but you'll find a lot more there, including our API documentation, as well as examples, and best practices.

If you're a maker, checkout freesewing.org where you can generate our sewing patterns adapted to your measurements.

♥️ Support FreeSewing: Become a patron ♥️

FreeSewing is an open source project run by a community, and financially supported by our patrons.

If you feel what we do is worthwhile, you too should become a patron.

5.6 KiB Raw Blame History