Add a new docs script. Build docs as npm run docs
This commit is contained in:
parent
0001f73329
commit
8545858f29
|
@ -1,36 +1,50 @@
|
|||
## Functions
|
||||
|
||||
<dl>
|
||||
<dt><a href="#convert">convert(path, dpi, length)</a></dt>
|
||||
<dd><p>Turn video into sheet of images</p>
|
||||
<dt><a href="#initialize">initialize(Commander)</a></dt>
|
||||
<dd></dd>
|
||||
<dt><a href="#convert">convert(input, dpi, length)</a></dt>
|
||||
<dd><p>Create image sequence from source video, using</p>
|
||||
</dd>
|
||||
<dt><a href="#stitch">stitch(loc, dim)</a></dt>
|
||||
<dt><a href="#stitch">stitch(output, dim, next, pageW, pageL)</a></dt>
|
||||
<dd><p>Stitch rendered frames into strips</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<a name="initialize"></a>
|
||||
|
||||
## initialize(Commander)
|
||||
**Kind**: global function
|
||||
|
||||
| Param | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| Commander | <code>Object</code> | object |
|
||||
|
||||
<a name="convert"></a>
|
||||
|
||||
## convert(path, dpi, length)
|
||||
Turn video into sheet of images
|
||||
## convert(input, dpi, length)
|
||||
Create image sequence from source video, using
|
||||
|
||||
**Kind**: global function
|
||||
|
||||
| Param | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| path | <code>String</code> | file path (absolute) |
|
||||
| input | <code>String</code> | file path (absolute) |
|
||||
| dpi | <code>Integer</code> | target printing dpi |
|
||||
| length | <code>Integer</code> | strip length in frames |
|
||||
|
||||
<a name="stitch"></a>
|
||||
|
||||
## stitch(loc, dim)
|
||||
## stitch(output, dim, next, pageW, pageL)
|
||||
Stitch rendered frames into strips
|
||||
|
||||
**Kind**: global function
|
||||
|
||||
| Param | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| loc | <code>String</code> | Path of folder containing frames |
|
||||
| output | <code>String</code> | Path of folder containing frames |
|
||||
| dim | <code>Object</code> | Dimensions object |
|
||||
| next | <code>function</code> | Async lib callback function |
|
||||
| pageW | <code>Integer</code> | Page width in inches |
|
||||
| pageL | <code>Integer</code> | Page length in inches |
|
||||
|
||||
|
|
|
@ -6,7 +6,8 @@
|
|||
"scripts": {
|
||||
"test": "echo \"Error: no test specified\" && exit 1",
|
||||
"build": "./node_modules/.bin/nexe ./ --build",
|
||||
"compile": "./node_modules/.bin/tsc ./src/v2f.ts --outFile ./v2f.js --noImplicitAny --lib ES2017 --lib ES2016 -t ES2016"
|
||||
"compile": "./node_modules/.bin/tsc ./src/v2f.ts --outFile ./v2f.js --noImplicitAny --lib ES2017 --lib ES2016 -t ES2016",
|
||||
"docs": "./node_modules/.bin/jsdoc2md ./v2f.js > ./docs/Readme.md"
|
||||
},
|
||||
"author": "mmcwilliams",
|
||||
"license": "MIT",
|
||||
|
|
Loading…
Reference in New Issue