diff --git a/docs/README.md b/docs/README.md index ad2e4aa..880f634 100644 --- a/docs/README.md +++ b/docs/README.md @@ -125,7 +125,7 @@ If you would like to contribute to this project, make sure you read the [contrib $ wireviz ~/path/to/file/mywire.yml ``` -This will output the following files +Depending on the options specified, this will output some or all of the following files: ``` mywire.gv GraphViz output @@ -135,13 +135,11 @@ mywire.bom.tsv BOM (bill of materials) as tab-separated text file mywire.html HTML page with wiring diagram and BOM embedded ``` -#### Command line options - -- `--prepend-file ` to prepend an additional YAML file. Useful for part libraries and templates shared among multiple cables/harnesses. -- `-o ` or `--output_file ` to generate output files with a name different from the input file. -- `-V` or `--version` to display the WireViz version. -- `-h` or `--help` to see a summary of the usage help text. +To see how to specify the output formats, as well as additional options, run: +``` +$ wireviz --help +``` ### Syntax description