Update project readme and a readme file for explaining the source.
This commit is contained in:
parent
c65f08d86c
commit
36c4875d1b
|
@ -3,7 +3,7 @@ v2f
|
|||
|
||||
Convert video to 16mm-sized strips of frames. For transferring to acetate and other experimental needs.
|
||||
|
||||
Look how easy it is to use:
|
||||
Use the distributed binary
|
||||
|
||||
./v2f ./path_to_video.mov 300
|
||||
|
||||
|
@ -22,7 +22,7 @@ Releases
|
|||
Dependencies
|
||||
------------
|
||||
|
||||
- node.js (or use a compiled version)
|
||||
- node.js (or use a [released version](https://github.com/sixteenmillimeter/v2f/releases/))
|
||||
- libav
|
||||
- ImageMagick
|
||||
|
||||
|
@ -37,11 +37,14 @@ Ubuntu
|
|||
|
||||
apt-get install libav imagemagick
|
||||
|
||||
|
||||
|
||||
Contribute
|
||||
----------
|
||||
|
||||
- Issue Tracker: https://github.com/sixteenmillimeter/v2f/issues
|
||||
- Source Code: https://github.com/sixteenmillimeter/v2f
|
||||
- Home Page: https://sixteenmillimeter.com/projects/v2f
|
||||
|
||||
Support
|
||||
-------
|
||||
|
|
|
@ -0,0 +1,36 @@
|
|||
## Functions
|
||||
|
||||
<dl>
|
||||
<dt><a href="#convert">convert(path, dpi, length)</a></dt>
|
||||
<dd><p>Turn video into sheet of images</p>
|
||||
</dd>
|
||||
<dt><a href="#stitch">stitch(loc, dim)</a></dt>
|
||||
<dd><p>Stitch rendered frames into strips</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<a name="convert"></a>
|
||||
|
||||
## convert(path, dpi, length)
|
||||
Turn video into sheet of images
|
||||
|
||||
**Kind**: global function
|
||||
|
||||
| Param | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| path | <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 rendered frames into strips
|
||||
|
||||
**Kind**: global function
|
||||
|
||||
| Param | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| loc | <code>String</code> | Path of folder containing frames |
|
||||
| dim | <code>Object</code> | Dimensions object |
|
||||
|
Loading…
Reference in New Issue