warehack.ing/WireViz
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve REAME.md

Browse Source
This commit is contained in:
Daniel Rojas 2021-10-15 16:06:00 +02:00
parent d6d1fbcf16
commit 3dae1cbca2
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/README.md
View File

@ -81,10 +81,11 @@ Output file:
[Source](../examples/demo02.yml) - [Bill of Materials](../examples/demo02.bom.tsv) [Source](../examples/demo02.yml) - [Bill of Materials](../examples/demo02.bom.tsv)
### Tutorial and example gallery ### Syntax, tutorial and example gallery
See the [tutorial page](../tutorial/readme.md) for sample code, Read the [syntax description](syntax.md) to learn about WireViz' features and how to use them.
as well as the [example gallery](../examples/readme.md) to see more of what WireViz can do.
See the [tutorial page](../tutorial/readme.md) for sample code, as well as the [example gallery](../examples/readme.md) to see more of what WireViz can do.
## Usage ## Usage
@ -135,16 +136,17 @@ mywire.bom.tsv BOM (bill of materials) as tab-separated text file
mywire.html HTML page with wiring diagram and BOM embedded mywire.html HTML page with wiring diagram and BOM embedded
``` ```
Wildcars in the file path are also supported to process multiple files at once, e.g.:
```
$ wireviz ~/path/to/files/*.yml
```
To see how to specify the output formats, as well as additional options, run: To see how to specify the output formats, as well as additional options, run:
``` ```
$ wireviz --help $ wireviz --help
``` ```
### Syntax description
A description of the WireViz YAML input syntax can be found [here](syntax.md).
### (Re-)Building the example projects ### (Re-)Building the example projects