From 5739cc30eed23b49243f1c54d1e33b3aa13b4134 Mon Sep 17 00:00:00 2001 From: Daniel Rojas Date: Mon, 15 Jun 2020 17:29:36 +0200 Subject: [PATCH] Expand tutorial text --- tutorial/readme.md | 23 +++++++++++++++++++++-- tutorial/tutorial01.md | 23 +++++++++++++++++++++-- 2 files changed, 42 insertions(+), 4 deletions(-) diff --git a/tutorial/readme.md b/tutorial/readme.md index 2bd9d36..fbef79b 100644 --- a/tutorial/readme.md +++ b/tutorial/readme.md @@ -1,8 +1,27 @@ # WireViz Tutorial ## Bare-bones example -* Minimum working example -* Only 1-to-1 sequential wiring +This is a minimal example that shows the basic WireViz syntax. A WireViz file consists of three sections: `connectors:` and `cables:` specify the components to be used, while `connections:` creates the links between components. + +### `connectors:` + +Each connector has a designator (a unique name) and can contain various parameters. The minimum requirement is `pincount`, specifying the number of ports to which wires can be attached. + +### `cables:` + +A cable is a collection of wires (for bundles of individual wires, see below). Just like connectors, they have a unique designator and a `wirecount`, i.e. the number of wires inside the cable. + +In this example, the cable is also given a `length`. This length must be specified in meters. + +### `connections:` + +This section is a list of connection sets. In this example, only one set is necessary. + +The set consists of three parts: A starting connector (`X1`), a cable (`W1`) and a destination connector (`X2`). + +This set specifies that connectos 1 through 4 of `X1` should go straight through wires 1 through 4 of `W1` and into connectors 1 through 4 of `X2`: A straight 1-to-1 wiring. + +For other ways of defining connection sets, see below. [Source](tutorial01.yml): diff --git a/tutorial/tutorial01.md b/tutorial/tutorial01.md index 156556f..5a53834 100644 --- a/tutorial/tutorial01.md +++ b/tutorial/tutorial01.md @@ -1,4 +1,23 @@ ## Bare-bones example -* Minimum working example -* Only 1-to-1 sequential wiring +his is a minimal example that shows the basic WireViz syntax. A WireViz file consists of three sections: `connectors:` and `cables:` specify the components to be used, while `connections:` creates the links between components. + +### `connectors` + +Each connector has a designator (a unique name) and can contain various parameters. The minimum requirement is `pincount`, specifying the number of ports to which wires can be attached. + +### `cables` + +A cable is a collection of wires (for bundles of individual wires, see below). Just like connectors, they have a unique designator and a `wirecount`, i.e. the number of wires inside the cable. + +In this example, the cable is also given a `length`. This length must be specified in meters. + +### `connections` + +This section is a list of connection sets. In this example, only one set is necessary. + +The set consists of three parts: A starting connector (`X1`), a cable (`W1`) and a destination connector (`X2`). + +This set specifies that connectos 1 through 4 of `X1` should go straight through wires 1 through 4 of `W1` and into connectors 1 through 4 of `X2`: A straight 1-to-1 wiring. + +For other ways of defining connection sets, see below.