Merge pull request #449 from cchampet/add_USAGE.md

Add USAGE.md

Author: cchampet

INSTALL.md

@@ -1,8 +1,7 @@
-TuttleOFX
-=========
+# TuttleOFX
 
 
-# External dependencies
+## External dependencies
 
 **The only required dependency is boost.**
 Other dependencies offer more plugins. See how to install them on your platform:
@@ -13,27 +12,46 @@ Other dependencies offer more plugins. See how to install them on your platform:
  * [Windows](INSTALL-ext-windows.md)
 
 
-# Compilation 
+## Compilation 
 
 ```bash
 ./configure
 make
 make install
 ```
 
-# Launch tests
+## Tested compilers
+
+- Linux
+ + GCC 4.1 on OpenSUSE 11.2 64bits
+ + GCC 4.4 on OpenSUSE 11.2 64bits
+ + GCC 4.6 on Ubuntu 12.04 64bits
+ + GCC 4.8 on Ubuntu 14.04 64bits
+ + Clang 3.4 on Ubuntu 12.04 64bits
+- MacOS
+ + Clang 4.2 64bits
+- Windows
+ + Visual C++ 2010 on Windows XP 32bits
+ + GCC-MINGW 3.4.5, 4.3.0 on Windows XP 32bits
+
+
+## Launch tests
 
 Some test (both C++ and python) need input images to work. You can get them from TuttleOFX-data repository:
+
 ```
 git clone https://github.com/tuttleofx/TuttleOFX-data.git
 ```
 
-* C++ tests
-Tests of host (```libraries/tuttle/tests```) and plugins (```tests``` directory in each plugin, with test files prefixed by "plugin_") with Boost Unit Test Framework.
-After compiling the project, executables are in ```testBin``` directory.
+- C++ tests
+
+Tests of host ( __libraries/tuttle/tests__ ) and plugins ( __tests__ directory in each plugin, with test files prefixed by "plugin_") with Boost Unit Test Framework.
+After compiling the project, executables are in __testBin__ directory.
+
+- Python tests
+
+Test of host ( __libraries/tuttle/pyTest__ ) with nosetests tool.
 
-* Python tests
-Test of host (```libraries/tuttle/pyTest```) with nosetests tool.
 ```
 nosetests libraries/tuttle/pyTest
 ```

README.md

@@ -13,14 +13,24 @@ The project is composed of 4 main parts:
 > - **Sam**, a set of command line tools.  
 
 [![Stories in Ready](https://badge.waffle.io/tuttleofx/tuttleofx.svg?label=1 - Ready)](http://waffle.io/tuttleofx/tuttleofx) <br />
-TuttleOFX is alive! 
+TuttleOFX is alive! <br/>
 See the next development steps with this badge above.
 
 License
 -------
 See [**COPYING.md**](COPYING.md)
 
 
+How to use
+-------
+See [**USAGE.md**](USAGE.md)
+
+
+Documentation
+-----------
+See [**Doxygen documentation**](http://tuttleofx.github.io/TuttleOFX-doxygen/).
+
+
 Compilation
 -----------
 Getting the source
@@ -34,29 +44,8 @@ Plugin creation
 See [**plugins/_scripts/README.md**](plugins/_scripts/README.md)
 
 
-Documentation
------------
-See [**Doxygen documentation**](http://tuttleofx.github.io/TuttleOFX-doxygen/).
-
-
-Tested compilers
-----------------
-
-- Linux
- + GCC 4.1 on OpenSUSE 11.2 64bits
- + GCC 4.4 on OpenSUSE 11.2 64bits
- + GCC 4.6 on Ubuntu 12.04 64bits
- + GCC 4.8 on Ubuntu 14.04 64bits
- + Clang 3.4 on Ubuntu 12.04 64bits
-- MacOS
- + Clang 4.2 64bits
-- Windows
- + Visual C++ 2010 on Windows XP 32bits
- + GCC-MINGW 3.4.5, 4.3.0 on Windows XP 32bits
-
-
 More information 
-----------------
+-----------
 
 Check TuttleOFX website for more information. 
 >[http://www.tuttleofx.org](http://www.tuttleofx.org)
@@ -69,7 +58,7 @@ OpenFX plugin standard.
 
 
 Contact
--------
+-----------
 
 Developers mailing-list (public)
 > [[email protected]](mailto:[email protected])  

USAGE.md

@@ -0,0 +1,28 @@
+# TuttleOFX
+
+This bunch of tools includes:
+* a set of command line tools called Sam,
+* some plugins like classical Resize, Lut, Crop... or LensDistort and Histogram Keyer.
+
+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).
+
+## Sam
+
+Additionnal dependencies:
+
+* __clint__
+
+Clint is a module filled with a set of awesome tools for developing commandline applications.
+
+https://pypi.python.org/pypi/clint/ <br/>
+Suggested version: v0.4.1
+
+* __argcomplete__
+
+Argcomplete provides easy, extensible command line tab completion of arguments for your Python script.
+
+https://pypi.python.org/pypi/argcomplete <br/>
+Suggested version: v0.9.0
+
+## More information
+http://www.tuttleofx.org/user-documentation