-
Notifications
You must be signed in to change notification settings - Fork 223
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add link to build_examples.py documentation (WIP)
- Loading branch information
1 parent
da3227e
commit 57def20
Showing
2 changed files
with
17 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# (Re-)Building the example projects | ||
|
||
<!-- | ||
The following text is taken from #118 | ||
https://github.com/formatc1702/WireViz/pull/118 | ||
TODO: write a better explaination --> | ||
|
||
|
||
- Run `python build_examples.py` to build generated files in all groups. | ||
- Run `python build_examples.py compare` to compare generated files in all groups against the last commit. | ||
- Run `python build_examples.py clean` to delete generated files in all groups. | ||
- Run `python build_examples.py restore` to restore generated files in all groups from the last commit. | ||
- Edit 4: 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. | ||
- Run `python build_examples.py -h` or with `--help` to print the generated help. The auto-generated help text is not the best, but better than maintaining it manually. I wonder if [click](https://click.palletsprojects.com/en/7.x/) as recommended in https://github.com/formatc1702/WireViz/issues/60#issuecomment-663278159 could improve this? |