summaryrefslogtreecommitdiff
path: root/graphics/pgf/contrib/ladder/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'graphics/pgf/contrib/ladder/README.md')
-rw-r--r--graphics/pgf/contrib/ladder/README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/graphics/pgf/contrib/ladder/README.md b/graphics/pgf/contrib/ladder/README.md
new file mode 100644
index 0000000000..3634746fab
--- /dev/null
+++ b/graphics/pgf/contrib/ladder/README.md
@@ -0,0 +1,29 @@
+# Lader TeX package
+_This package permit the creation of simple ladder diagram into TeX documents._
+
+[Example](https://github.com/AurelienC/tex-ladder/blob/master/ladder.pdf)
+
+## Usage
+The code must be inserted between en `tikzpicture` section.
+
+Add the packages :
+ \usepackage{tikz}
+ \usepackage{Ladder}
+
+
+
+### Net
+_All contacts and relays are, by default, added in series_
+* `LadderLine` begin a new ladder net
+* `startParallel` begin a parallel segment
+* `setParallel` begin the new parallel segment
+* `unsetParallel` end of the parallel segment
+
+### Contacts
+* `LadderNO[type]{name}{mnemonic}` a Normally Opened contact
+* `LadderNC[type]{name}{mnemonic}` a Normaly Closed contact
+_Type may be P (rising edge), N (falling edge)..._
+
+### Relays
+* `LadderB[type]{name}{mnemonic}` a relay
+_Type may be R (reset), S (set)..._