Skip to content

Commit

Permalink
Add minor corrections
Browse files Browse the repository at this point in the history
  • Loading branch information
17o2 committed Oct 16, 2020
1 parent 8a9781f commit 3da1eac
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ mywire.html HTML page with wiring diagram and BOM embedded

- `--prepend-file <FILE>` to prepend an additional YAML file. Useful for part libraries and templates shared among multiple cables/harnesses.
- `-o <OUTPUT>` or `--output_file <OUTPUT>` to generate output files with a name different from the input file.
- `-v` or `--version` to display the WireViz version.
- `-V` or `--version` to display the WireViz version.
- `-h` or `--help` to see a summary of the usage help text.


Expand Down
2 changes: 2 additions & 0 deletions docs/buildscript.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,13 @@ TODO: write a better explaination -->
- `python build_examples.py compare` to compare generated files in all groups against the last commit.
- `python build_examples.py clean` to delete generated files in all groups.
- `python build_examples.py restore` to restore generated files in all groups from the last commit.
- `python build_examples.py -V` or `--version` to display the WireViz version.
- `python build_examples.py -h` or `--help` to see a summary of the usage help text.


## Options

- Append `-b` or `--branch` followed by a specified branch or commit to compare with or restore from (default: The last commit in the current branch).
- Append `-c` or `--compare-graphviz-output` to the `compare` command above to also compare the Graphviz output (default: False).
- Append `-g` or `--groups` followed by space separated group names to any command above, and the set of generated files affected by the command will be limited to the selected groups.
Possible group names:
Expand Down

0 comments on commit 3da1eac

Please sign in to comment.