16mm
/
bellows-generator
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update readme to actually link the github pages.

This commit is contained in:
mmcw-dev 2017-12-27 20:10:49 -05:00
parent 263f170b59
commit a91da2ef55
2 changed files with 47 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -5,11 +5,18 @@
```js
const bellows = require('bellows')
```
* [bellows](#module_bellows)
* [bellows([options])](#exp_module_bellows--bellows) ⏏
* [~IN](#module_bellows--bellows..IN)
<a name="exp_module_bellows--bellows"></a>
### bellows([options]) ⏏
Generate bellows pattern for cutting and folding.
**Kind**: Exported function
**Typicalname:bellows**: Generate bellows pattern for cutting and folding.
**Typicalname:bellows**:
| Param | Type | Description |
| --- | --- | --- |
@ -36,3 +43,22 @@ const bellows = require('bellows')
const b = bellows({ parts : 2 })
console.log(b)
```
<a name="module_bellows--bellows..IN"></a>
#### bellows~IN
Try it out [in the browser](https://sixteenmillimeter.github.io/bellows/).
### Install (node.js)
First, install dependencies required by
[node-canvas](https://github.com/Automattic/node-canvas) by following
the [install instructions](https://github.com/Automattic/node-canvas#installation)
for your OS.
```
git clone https://github.com/sixteenmillimeter/bellows.git
cd bellows
npm install
```
**Kind**: inner constant of [<code>bellows</code>](#exp_module_bellows--bellows)

39
src/bellows.js
View File

@ -6,6 +6,23 @@
* const bellows = require('bellows')
*/
/**
* Try it out [in the browser](https://sixteenmillimeter.github.io/bellows/).
*
* ### Install (node.js)
*
* First, install dependencies required by
* [node-canvas](https://github.com/Automattic/node-canvas) by following
* the [install instructions](https://github.com/Automattic/node-canvas#installation)
* for your OS.
*
* ```
* git clone https://github.com/sixteenmillimeter/bellows.git
* cd bellows
* npm install
* ```
*/
const IN = 25.4
const BLACK = '0,0,0,1.0'
const RED = '255,0,0,1.0'
@ -56,10 +73,11 @@ function taper (back, front, length, pos) {
}
/**
* Generate bellows pattern for cutting and folding.
*
* @alias module:bellows
* @typicalname:bellows
*
* Generate bellows pattern for cutting and folding.
*
* @param {Object} [options] Bellows configuration options
* @param {Integer} [options.dpi] DPI of the image
@ -538,21 +556,4 @@ function bellows (options = {}) {
if (!browser) {
module.exports = bellows
}
/**
* Try it out [in the browser](https://sixteenmillimeter.github.io/bellows/).
*
* ### Install (node.js)
*
* First, install dependencies required by
* [node-canvas](https://github.com/Automattic/node-canvas) by following
* the [install instructions](https://github.com/Automattic/node-canvas#installation)
* for your OS.
*
*```
* git clone https://github.com/sixteenmillimeter/bellows.git
* cd bellows
* npm install
*```
*/
}