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

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

7 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-cutonfold

A FreeSewing plugin to add cut-on-fold indicators on your patterns

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

plugin-cutonfold

A freesewing plugin to add cut-on-fold indicators to your patterns.

Install

On node.js:

npm install @freesewing/plugin-cutonfold

in the browser, simply include this script:

<script type="text/javascript" src="https://unpkg.com/@freesewing/plugin-cutonfold"></script>

Loading this plugin

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

On node.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.

<script type="text/javascript" src="https://unpkg.com/freesewing"></script>
<script type="text/javascript" src="https://unpkg.com/@freesewing/plugin-cutonfold"></script>
<script type="text/javascript" src="https://unpkg.com/@freesewing/pattern-brian"></script>

<script>
var pattern = freesewing.patterns.brian;
</script>

Usage

This plugin provides the cutonfold macro.

The macro method is available from the shorthand() method on an instantiated pattern part.

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

Build

To build this plugin, run:

npm run build

License: MIT

See the license file for details.

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.

7 KiB Raw Blame History