Skip to content

Commit f68e79a

Browse files
author
Clement Champetier
committed
Add USAGE.md
Add link in README.md
1 parent 63c4120 commit f68e79a

File tree

2 files changed

+33
-0
lines changed

2 files changed

+33
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,11 @@ License
2121
See [**COPYING.md**](COPYING.md)
2222

2323

24+
How to use
25+
-------
26+
See [**USAGE.md**](USAGE.md)
27+
28+
2429
Compilation
2530
-----------
2631
Getting the source

USAGE.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# TuttleOFX
2+
3+
This bunch of tools includes:
4+
* a set of command line tools called Sam,
5+
* some plugins like classical Resize, Lut, Crop... or LensDistort and Histogram Keyer.
6+
7+
TuttleOFX plugins are based on OpenFX standard, making them usable with the Sam command line tool but also with other applications like Nuke (The Foundry), Scratch (Assimilate), Baselight (FilmLight), Mistika (SGO).
8+
9+
## Sam
10+
11+
Additionnal dependencies:
12+
13+
* __clint__
14+
15+
Clint is a module filled with a set of awesome tools for developing commandline applications.
16+
17+
https://pypi.python.org/pypi/clint/ <br/>
18+
Suggested version: v0.4.1
19+
20+
* __argcomplete__
21+
22+
Argcomplete provides easy, extensible command line tab completion of arguments for your Python script.
23+
24+
https://pypi.python.org/pypi/argcomplete <br/>
25+
Suggested version: v0.9.0
26+
27+
## More information
28+
http://www.tuttleofx.org/user-documentation

0 commit comments

Comments
 (0)