Skip to content

Commit

Permalink
Add link to build_examples.py documentation (WIP)
Browse files Browse the repository at this point in the history
  • Loading branch information
formatc1702 committed Aug 1, 2020
1 parent da3227e commit 57def20
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 5 deletions.
6 changes: 1 addition & 5 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,11 +137,7 @@ A description of the WireViz YAML input syntax can be found [here](syntax.md).

### (Re-)Building the example projects

If you would like to rebuild all of the included demos, examples and tutorials, use the `build_examples.py` script:

```cd src/wireviz
./build_examples.py
```
Please see the [documentation of the `build_examples.py` script](buildscript.md) for info on building the demos, examples and tutorial.

## Changelog

Expand Down
16 changes: 16 additions & 0 deletions docs/buildscript.md
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?

0 comments on commit 57def20

Please sign in to comment.