Rebuild READMEs

2020-07-20 17:39:06 +02:00 · 2020-07-20 17:39:06 +02:00 · 94b3ffa3ea
commit 94b3ffa3ea
parent 35561d1db1
2 changed files with 147 additions and 177 deletions
--- a/examples/readme.md
+++ b/examples/readme.md
@ -1,61 +1,62 @@
-# Example gallery
-## Example 09
-![](../../examples/ex09.png)
-
-[Source](ex09.yml) - [Bill of Materials](../../examples/ex09.bom.tsv)
-
-
-## Example 08
-![](../../examples/ex08.png)
-
-[Source](ex08.yml) - [Bill of Materials](../../examples/ex08.bom.tsv)
-
+# Example Gallery

 ## Example 01
-![](../../examples/ex01.png)
+![](ex01.png)

-[Source](ex01.yml) - [Bill of Materials](../../examples/ex01.bom.tsv)
-
-
-## Example 03
-![](../../examples/ex03.png)
-
-[Source](ex03.yml) - [Bill of Materials](../../examples/ex03.bom.tsv)
+[Source](ex01.yml) - [Bill of Materials](ex01.bom.tsv)


 ## Example 02
-![](../../examples/ex02.png)
+![](ex02.png)

-[Source](ex02.yml) - [Bill of Materials](../../examples/ex02.bom.tsv)
+[Source](ex02.yml) - [Bill of Materials](ex02.bom.tsv)


-## Example 06
-![](../../examples/ex06.png)
+## Example 03
+![](ex03.png)

-[Source](ex06.yml) - [Bill of Materials](../../examples/ex06.bom.tsv)
-
-
-## Example 07
-![](../../examples/ex07.png)
-
-[Source](ex07.yml) - [Bill of Materials](../../examples/ex07.bom.tsv)
-
-
-## Example 05
-![](../../examples/ex05.png)
-
-[Source](ex05.yml) - [Bill of Materials](../../examples/ex05.bom.tsv)
-
-
-## Example 10
-![](../../examples/ex10.png)
-
-[Source](ex10.yml) - [Bill of Materials](../../examples/ex10.bom.tsv)
+[Source](ex03.yml) - [Bill of Materials](ex03.bom.tsv)


 ## Example 04
-![](../../examples/ex04.png)
+![](ex04.png)

-[Source](ex04.yml) - [Bill of Materials](../../examples/ex04.bom.tsv)
+[Source](ex04.yml) - [Bill of Materials](ex04.bom.tsv)
+
+
+## Example 05
+![](ex05.png)
+
+[Source](ex05.yml) - [Bill of Materials](ex05.bom.tsv)
+
+
+## Example 06
+![](ex06.png)
+
+[Source](ex06.yml) - [Bill of Materials](ex06.bom.tsv)
+
+
+## Example 07
+![](ex07.png)
+
+[Source](ex07.yml) - [Bill of Materials](ex07.bom.tsv)
+
+
+## Example 08
+![](ex08.png)
+
+[Source](ex08.yml) - [Bill of Materials](ex08.bom.tsv)
+
+
+## Example 09
+![](ex09.png)
+
+[Source](ex09.yml) - [Bill of Materials](ex09.bom.tsv)
+
+
+## Example 10
+![](ex10.png)
+
+[Source](ex10.yml) - [Bill of Materials](ex10.bom.tsv)


--- a/tutorial/readme.md
+++ b/tutorial/readme.md
@ -1,62 +1,33 @@
 # WireViz Tutorial
-## 08 - Part numbers

-* Part number information can be added to parts
-  * Only provided fields will be added to the diagram and bom
-* Bundles can have part information specified by wire
+## 01 - Bare-bones example
+
+* Minimum working example
+* Only 1-to-1 sequential wiring

-[Source](tutorial08.yml):

 ```yaml
 connectors:
-  X1: &template1 # define a template for later use
-    type: Molex KK 254
+  X1:
    pincount: 4
-    subtype: female
-    manufacturer: Molex
-    manufacturer_part_number: 22013047
  X2:
-    <<: *template1 # reuse template
-    internal_part_number: CON4
-  X3:
-    <<: *template1 # reuse template
+    pincount: 4

 cables:
  W1:
    wirecount: 4
    length: 1
-    gauge: 0.25 mm2
-    color_code: IEC
-    manufacturer: CablesCo
-    manufacturer_part_number: ABC123
-    internal_part_number: CAB1
-  W2:
-    category: bundle
-    length: 1
-    gauge: 0.25 mm2
-    colors: [YE, BK, BK, RD]
-    manufacturer: [WiresCo,WiresCo,WiresCo,WiresCo]
-    manufacturer_part_number: [W1-YE,W1-BK,W1-BK,W1-RD]
-    internal_part_number: [WIRE1,WIRE2,WIRE2,WIRE3]
-

 connections:
  -
    - X1: [1-4]
    - W1: [1-4]
    - X2: [1-4]
-  -
-    - X1: [1-4]
-    - W2: [1-4]
-    - X3: [1-4]
 ```

+![](tutorial01.png)

-Output:
-
-![](tutorial../../tutorial/tutorial08.png)
-
-[Bill of Materials](tutorial../../tutorial/tutorial08.bom.tsv)
+[Source](tutorial01.yml) - [Bill of Materials](tutorial01.bom.tsv)


 ## 02 - Adding parameters and colors
@ -65,7 +36,6 @@ Output:
 * Auto-calculate equivalent AWG from mm2
 * Non-sequential wiring

-[Source](tutorial02.yml):

 ```yaml
 connectors:
@ -96,12 +66,9 @@ connections:
    - X2: [1,2,4,3]
 ```

+![](tutorial02.png)

-Output:
-
-![](tutorial../../tutorial/tutorial02.png)
-
-[Bill of Materials](tutorial../../tutorial/tutorial02.bom.tsv)
+[Source](tutorial02.yml) - [Bill of Materials](tutorial02.bom.tsv)


 ## 03 - Pinouts, shielding, templates (I)
@ -112,7 +79,6 @@ Output:
 * Cable shielding, shield wiring
 * Templates

-[Source](tutorial03.yml):

 ```yaml
 connectors:
@ -142,46 +108,9 @@ connections:
    - W1: s
 ```

+![](tutorial03.png)

-Output:
-
-![](tutorial../../tutorial/tutorial03.png)
-
-[Bill of Materials](tutorial../../tutorial/tutorial03.bom.tsv)
-
-
-## 01 - Bare-bones example
-
-* Minimum working example
-* Only 1-to-1 sequential wiring
-
-[Source](tutorial01.yml):
-
-```yaml
-connectors:
-  X1:
-    pincount: 4
-  X2:
-    pincount: 4
-
-cables:
-  W1:
-    wirecount: 4
-    length: 1
-
-connections:
-  -
-    - X1: [1-4]
-    - W1: [1-4]
-    - X2: [1-4]
-```
-
-
-Output:
-
-![](tutorial../../tutorial/tutorial01.png)
-
-[Bill of Materials](tutorial../../tutorial/tutorial01.bom.tsv)
+[Source](tutorial03.yml) - [Bill of Materials](tutorial03.bom.tsv)


 ## 04 - Templates (II), notes, American standards, daisy chaining (I)
@ -192,7 +121,6 @@ Output:
 * Linear daisy-chain
  * Convenient for shorter chains

-[Source](tutorial04.yml):

 ```yaml
 connectors:
@ -233,12 +161,9 @@ connections:
    - X3: [1-4]
 ```

+![](tutorial04.png)

-Output:
-
-![](tutorial../../tutorial/tutorial04.png)
-
-[Bill of Materials](tutorial../../tutorial/tutorial04.bom.tsv)
+[Source](tutorial04.yml) - [Bill of Materials](tutorial04.bom.tsv)


 ## 05 - Ferrules, wire bundles, custom wire colors
@ -255,7 +180,6 @@ Output:
 * Custom wire colors
  * Wirecount can be implicit in color list

-[Source](tutorial05.yml):

 ```yaml
 connectors:
@ -284,12 +208,54 @@ connections:
    - X1: [1-4]
 ```

+![](tutorial05.png)

-Output:
+[Source](tutorial05.yml) - [Bill of Materials](tutorial05.bom.tsv)

-![](tutorial../../tutorial/tutorial05.png)

-[Bill of Materials](tutorial../../tutorial/tutorial05.bom.tsv)
+## 06 - Custom ferrules
+
+* Custom ferrules
+  * Allows attaching more than one wire to a ferrule
+  * Requires defining them as regular connectors with unique designators, adding `category: ferrule` parameter
+
+
+```yaml
+connectors:
+  X1:
+    pinout: [+12V, GND, GND, +5V]
+    type: Molex 8981
+    subtype: female
+  F_10: # this is a unique ferrule
+    style: simple
+    show_name: false # non-autogenerated connectors show their name by default; override
+    type: Crimp ferrule
+    subtype: 1.0 mm²
+    color: YE # optional color
+  F_05: # this is a ferrule that will be auto-generated on demand
+    style: simple
+    autogenerate: true
+    type: Crimp ferrule
+    subtype: 0.5 mm²
+    color: OG
+
+cables:
+  W1:
+    category: bundle # bundle
+    length: 0.3
+    gauge: 0.5 mm2
+    colors: [YE, BK, BK, RD] # custom colors, wirecount is implicit
+
+connections:
+    -
+      - [F_05, F_10, F_10, F_05]
+      - W1: [1-4]
+      - X1: [1-4]
+```
+
+![](tutorial06.png)
+
+[Source](tutorial06.yml) - [Bill of Materials](tutorial06.bom.tsv)


 ## 07 - Daisy chaining (II)
@ -297,7 +263,6 @@ Output:
 * Zig-zag daisy chain
  * Convenient for longer chains

-[Source](tutorial07.yml):

 ```yaml
 connectors:
@ -354,60 +319,64 @@ connections:
    - X6: [1-4]
 ```

+![](tutorial07.png)

-Output:
-
-![](tutorial../../tutorial/tutorial07.png)
-
-[Bill of Materials](tutorial../../tutorial/tutorial07.bom.tsv)
+[Source](tutorial07.yml) - [Bill of Materials](tutorial07.bom.tsv)


-## 06 - Custom ferrules
+## 08 - Part numbers

-* Custom ferrules
-  * Allows attaching more than one wire to a ferrule
-  * Requires defining them as regular connectors with unique designators, adding `category: ferrule` parameter
+* Part number information can be added to parts
+  * Only provided fields will be added to the diagram and bom
+* Bundles can have part information specified by wire

-[Source](tutorial06.yml):

 ```yaml
 connectors:
-  X1:
-    pinout: [+12V, GND, GND, +5V]
-    type: Molex 8981
+  X1: &template1 # define a template for later use
+    type: Molex KK 254
+    pincount: 4
    subtype: female
-  F_10: # this is a unique ferrule
-    style: simple
-    show_name: false # non-autogenerated connectors show their name by default; override
-    type: Crimp ferrule
-    subtype: 1.0 mm²
-    color: YE # optional color
-  F_05: # this is a ferrule that will be auto-generated on demand
-    style: simple
-    autogenerate: true
-    type: Crimp ferrule
-    subtype: 0.5 mm²
-    color: OG
+    manufacturer: Molex
+    manufacturer_part_number: 22013047
+  X2:
+    <<: *template1 # reuse template
+    internal_part_number: CON4
+  X3:
+    <<: *template1 # reuse template

 cables:
  W1:
-    category: bundle # bundle
-    length: 0.3
-    gauge: 0.5 mm2
-    colors: [YE, BK, BK, RD] # custom colors, wirecount is implicit
+    wirecount: 4
+    length: 1
+    gauge: 0.25 mm2
+    color_code: IEC
+    manufacturer: CablesCo
+    manufacturer_part_number: ABC123
+    internal_part_number: CAB1
+  W2:
+    category: bundle
+    length: 1
+    gauge: 0.25 mm2
+    colors: [YE, BK, BK, RD]
+    manufacturer: [WiresCo,WiresCo,WiresCo,WiresCo]
+    manufacturer_part_number: [W1-YE,W1-BK,W1-BK,W1-RD]
+    internal_part_number: [WIRE1,WIRE2,WIRE2,WIRE3]
+

 connections:
-    -
-      - [F_05, F_10, F_10, F_05]
-      - W1: [1-4]
-      - X1: [1-4]
+  -
+    - X1: [1-4]
+    - W1: [1-4]
+    - X2: [1-4]
+  -
+    - X1: [1-4]
+    - W2: [1-4]
+    - X3: [1-4]
 ```

+![](tutorial08.png)

-Output:
-
-![](tutorial../../tutorial/tutorial06.png)
-
-[Bill of Materials](tutorial../../tutorial/tutorial06.bom.tsv)
+[Source](tutorial08.yml) - [Bill of Materials](tutorial08.bom.tsv)