templates: nodemcu-arduino: better symbol names.

o Adding some documentation to the readme. Adding a small flow chart illustrating how the tool work with a schematic, netlist and template to generate a header file.

1 files changed, 29 insertions, 0 deletions

diff --git a/doc/flow.tikz b/doc/flow.tikz
new file mode 100644
index 0000000..4c6c49e
--- /dev/null
+++ b/doc/flow.tikz
@@ -0,0 +1,29 @@
+\begin{tikzpicture}
+[
+major/.style={rectangle,draw,rounded corners, thick, align=center, minimum size=20mm},
+minor/.style={rectangle,draw,rounded corners, thick, minimum width=40mm, minimum height=15mm}
+]
+
+\node (generate-header)[major] {\texttt{generate-header}};
+\node (netlist)[major, above=5em of generate-header] {Netlist\\\texttt{foo.net}};
+\node (schematic)[major, above=5em of netlist] {Schematic\\\texttt{foo.sch}};
+\node (header)[major, below=5em of generate-header] {Header\\\texttt{foo.h}};
+\node (template)[major, left=5em of netlist] {Template\\\texttt{my-template}};
+
+\draw [-Straight Barb, thick]
+  (schematic.south) -- (netlist.north)
+  node[above, midway] {};
+
+\draw [-Straight Barb, thick]
+  (netlist.south) -- (generate-header.north)
+  node[above, near end] {};
+
+\draw [-Straight Barb, thick]
+  (generate-header.south) -- (header.north)
+  node[above, midway] {};
+
+\draw [-Straight Barb, thick]
+  (template.south) |- (generate-header.west)
+  node[above, near end] {};
+
+\end{tikzpicture}