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

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

6.4 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-designer

A FreeSewing plugin to facilitate pattern design

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

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:

npm install @freesewing/plugin-designer

in the browser, simply include this script:

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

Loading this plugin

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

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

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

<script>
var pattern = freesewing.patterns.brian
  .with(freesewing.plugins.cutonfold);
</script>

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.

6.4 KiB Raw Blame History