update docs for command line options

README.md

@@ -8,9 +8,21 @@ This project lets your quickly compose in Ardour, but then export to notation so
 ## How to use
 1. Install [python](https://python.org) and add to your path.
 2. From the command run: `pip install mido` (see [mido instructions](https://mido.readthedocs.io/en/latest/installing.html) for details).
-3. Run `python main.py -f _path/to/file.ardour_`
+3. Run `python main.py`
 4. Open the MIDI file in your favorite notation software.
 
+## Command line options
+<dl>
+<dt>-h, --help</dt>
+<dd>show a list of command line options</dd>
+
+<dt>-f FILE, --file FILE</dt>
+<dd>source FILE you would like to convert. Use Linux-style path conventions (like  ~/Ardour Folder/My Session.ardour) or Windows (like C:/Users/username/Ardour Folder/My Session.ardour).</dd>
+
+<dt>-v, --verbose</dt>
+<dd>show MIDI messages and other debugging information</dd>
+</dl>
+
 ## Limitations
 * Export ignores any tempo changes (due to the complexity of extracting that information from Ardour)
 * Export fails on any overlapping regions. For accurate results, remove any overlapping regions in your Ardour session before exporting. (Technically, only overlapping events between two regions are a problem.)

main.py

@@ -8,10 +8,10 @@
 # Process command line arguments
 parser = ArgumentParser()
 parser.add_argument("-f", "--file", dest="filename",
-                    help="Optionally include the Ardour source file from the command line. Use Linux-style path conventions (like  ~/Ardour Folder/My Session.ardour) or Windows (like C:/Users/username/Ardour Folder/My Session.ardour).", metavar="FILE")
+                    help="source FILE you would like to convert. Use Linux-style path conventions (like  ~/Ardour Folder/My Session.ardour) or Windows (like C:/Users/username/Ardour Folder/My Session.ardour).", metavar="FILE")
 parser.add_argument("-v", "--verbose",
                     action="store_true", dest="verbose", default=False,
-                    help="Display MIDI messages and other debugging information.")
+                    help="show MIDI messages and other debugging information.")
 
 args = parser.parse_args()