diff --git a/README.md b/README.md index bf9f720..b7844d5 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,18 @@ Read Pro Tools text exports and generate PDF reports, JSON output. ## Quick Start For a quick overview of how to cue ADR with `ptulsconv`, check out the [Quickstart](doc/QUICKSTART.md). - + + +## Installation + +The easiest way to install on your site is to use `pip`: + + % pip3 install ptulsconv + +This will install the necessary libraries on your host and gives you +command-line access to the tool through an entry-point `ptulsconv`. In a +terminal window type `ptulsconv -h` for a list of available options. + ## Theory of Operation @@ -27,33 +38,6 @@ PDF and CSV documents for use in ADR spotting, recording, editing and reporting, and supplemental JSON documents can be output for use with other workflows. -### Reports Generated by ptulsconv by Default - -1. "ADR Report" lists every line in an export with most useful fields, sorted - by time. -2. "Continuity" lists every scene sorted by time. -3. "Line Count" lists a count of every line, collated by reel number and by - effort/TV/optional line designation. -4. "CSV" is a folder of files of all lines collated by character and reel - as CSV files, for use by studio cueing workflows. -5. "Director Logs" is a folder of PDFs formatted like the "ADR Report" except - collated by character. -6. "Supervisor Logs" creates a PDF report for every character, with one line - per page, optimized for note-taking. -7. "Talent Scripts" is a minimal PDF layout of just timecode and line prompt, - collated by character. - - [avp]: http://www.avid.com/pro-tools - -## Installation - -The easiest way to install on your site is to use `pip`: - - % pip3 install ptulsconv - -This will install the necessary libraries on your host and gives you -command-line access to the tool through an entry-point `ptulsconv`. In a -terminal window type `ptulsconv -h` for a list of available options.