Refactored the README, pushing lots of stuff to the wiki. (#294)

Author: jminor

README.md

@@ -38,22 +38,7 @@ OpenTimelineIO format.
 Use Cases
 ---------
 
-- I have a timeline in Adobe Premiere, and I want to bring that cut into my
-    in-house animation system.
-- I have a timeline in Avid Media Composer, and my Producer wants to know a
-     full list of the media I'm using.
-- I am about to render a bunch of shots & I want to make sure my frame ranges
-    match what Editorial is asking for (not too long or too short).
-- The Editor just added some cross dissolves and I need to know how many more
-     frames (at head or tail) of which shots need to be rendered.
-- Legal needs a list of all the audio we're using (music, effects, dialogue) in
-     the current cut.
-- TDs/Animators want to get a cut from Editorial for reference, and then splice
-     their updated renders/recordings into that cut.
-- Editorial is working with proxy media (QuickTime, MXF, etc.) and I want to
-    gather all the EXRs that correspond with that & bring those into Nuke.
-
-For more use cases, see: https://github.com/PixarAnimationStudios/OpenTimelineIO/wiki/Use-Cases
+See: https://github.com/PixarAnimationStudios/OpenTimelineIO/wiki/Use-Cases
 
 Architecture
 ------------
@@ -63,111 +48,50 @@ See: https://github.com/PixarAnimationStudios/OpenTimelineIO/wiki/Architecture
 Adapters
 --------
 
-OpenTimelineIO supports, or plans to support, conversion adapters for these
-formats:
+OpenTimelineIO supports, or plans to support, conversion adapters for many
+existing file formats, such as Final Cut Pro XML, AAF, CMX 3600 EDL, etc.
 
-### Final Cut Pro XML ###
+See: https://github.com/PixarAnimationStudios/OpenTimelineIO/wiki/Adapters
 
-Final Cut 7 XML Format
-- Status: Supported via the `fcp_xml` adapter
-- https://developer.apple.com/library/content/documentation/AppleApplications/Reference/FinalCutPro_XML/AboutThisDoc/AboutThisDoc.html#//apple_ref/doc/uid/TP30001152-TPXREF101
-
-Final Cut Pro X XML Format:
-- Status: https://github.com/PixarAnimationStudios/OpenTimelineIO/issues/37
-- https://developer.apple.com/library/mac/documentation/FinalCutProX/Reference/FinalCutProXXMLFormat/Introduction/Introduction.html
-
-### Adobe Premiere Project ###
-
-- Based on guidance from Adobe, we support interchange with Adobe Premiere via 
-    the FCP 7 XML format (see above).
-
-### CMX3600 EDL ###
-
-- Status: Supported via the `cmx_3600` adapter
-- Includes support for ASC_CDL color correction metadata
-- Full specification: SMPTE 258M-2004 "For Television −− Transfer of Edit Decision Lists"
-- http://xmil.biz/EDL-X/CMX3600.pdf
-- https://documentation.apple.com/en/finalcutpro/usermanual/index.html#chapter=96%26section=1
-
-### Avid AAF ###
-
-- Status: Supports reading simple AAF compositions
-  - Reading: https://github.com/PixarAnimationStudios/OpenTimelineIO/issues/1
-  - Writing: https://github.com/PixarAnimationStudios/OpenTimelineIO/issues/236
-- http://www.amwa.tv/downloads/specifications/aafobjectspec-v1.1.pdf
-- http://www.amwa.tv/downloads/specifications/aafeditprotocol.pdf
-
-- set ${OTIO_AAF_PYTHON_LIB} to point the location of the PyAAF module.
-
-Contrib Adapters
-----------------
-
-The contrib area hosts adapters which come from the community (_not_ supported 
-    by the core-otio team) and may require extra dependencies.
-
-### RV Session File ###
-
-- Status: write-only adapter supported via the `rv_session` adapter.
-- need to set environment variables to locate `py-interp` and `rvSession.py` 
-    from within the RV distribution
-- set ${OTIO_RV_PYTHON_BIN} to point at `py-interp` from within rv, for 
-    example:
-    `setenv OTIO_RV_PYTHON_BIN /Applications/RV64.app/Contents/MacOS/py-interp`
-- set ${OTIO_RV_PYTHON_LIB} to point at the parent directory of `rvSession.py`:
-    `setenv OTIO_RV_PYTHON_LIB /Applications/RV64.app/Contents/src/python`
-    
-### Maya Sequencer ###
+Installing / Quick-Start
+----------
 
-- Status: supported via the `maya_sequencer` adapter.
-- set ${OTIO_MAYA_PYTHON_BIN} to point the location of `mayapy` within the maya 
-    installation.
+You can install OpenTimelineIO via
 
-### HLS Playlist ###
+`pip install opentimelineio`
 
-- Status: supported via the `hls_playlist` adapter.
+For more details, including how to run the included viewer program, see: https://github.com/PixarAnimationStudios/OpenTimelineIO/wiki/OTIOView-Quick-Start-Guide
 
-### Avid Log Exchange (ALE) ###
+Example Usage
+-------
 
-- Status: supported via the `ale` adapter.
+```
+import opentimelineio as otio
 
-### Text Burn-in Adapter ###
+timeline = otio.adapters.read_from_file("foo.aaf")
+for clip in timeline.each_clip():
+  print clip.name, clip.duration()
+```
 
-Uses FFmpeg to burn text overlays into video media.
+There are more code examples here: https://github.com/PixarAnimationStudios/OpenTimelineIO/tree/master/examples
 
-- Status: supported via the `burnins` adapter.
+Also, looking through the unit tests is a great way to see what OTIO can do:
+https://github.com/PixarAnimationStudios/OpenTimelineIO/tree/master/tests
 
-Installing
-----------
+Developing
+-------
 
-run:
-```
-python setup.py install
-```
+If you want to contribute to the project, please see: https://github.com/PixarAnimationStudios/OpenTimelineIO/wiki/Contributing
 
-To build and install the project.
+You can get the latest development version via:
 
-Makefile
---------
+`git clone git@github.com:PixarAnimationStudios/OpenTimelineIO.git OpenTimelineIO`
 
-Even though the project is python, we provide a makefile with some utility 
-targets.  These include targets for running unit tests and for running 
-a linter to conform to style guide.  To run the target:
-
-```bash
-# run the unit tests
-make test
-# run the unit tests with verbose output
-make test VERBOSE=1
-# run the code through a linter
-make lint
-# generate a coverage report
-make coverage
-```
+You can install development dependencies with `pip install -e .[dev]`
 
-Developing
-----------
+You can also install the PySide2 dependency with `pip install -e .[view]`
 
-Currently the code base is written against python2.7 and python3.5, in keeping 
+Currently the code base is written against python 2.7 and python 3.5, in keeping 
 with the pep8 style.  We ask that before you submit a pull request, you:
 
 - run `make test` -- to ensure that none of the unit tests were broken
@@ -176,10 +100,6 @@ with the pep8 style.  We ask that before you submit a pull request, you:
 
 PEP8: https://www.python.org/dev/peps/pep-0008/
 
-You can install development dependencies with `pip install -e .[dev]`
-
-You can also install the PySide2 dependency with `pip install -e .[view]`
-
 Contact
 -------