1
0
Fork 0
freesewing/README.md
Joost De Cock 869f900829 ✏️ README update
2018-08-13 09:36:14 +02:00

2.3 KiB

Freesewing logo

 freesewing
a library for made-to-measure sewing patterns

Travis build Version License Chat on Gitter Become a Patron

# freesewing

Freesewing is an open source platform for made-to-measure sewing pattern.
This is our core library. A freesewing plugin to display debug information in your browser console.

Usage

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

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

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

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

Example

This plugin will gather debug info and log it to your browser console:

Example of the output provided by this plugin

Install

To install, run:

npm install @freesewing/plugin-debug

Build

To build this plugin, run:

npm run build

License: MIT

See the license file for details.