From 1dadec53a7a61eae9d37ba2aabf96efea1ad0ac9 Mon Sep 17 00:00:00 2001 From: Trygve Laugstøl Date: Wed, 10 Aug 2016 02:16:02 +0200 Subject: 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. --- .gitmodules | 3 + CMakeLists.txt | 1 + README.md | 76 ++++++++++++++ cli/generate-header.cpp | 2 +- doc/CMakeLists.txt | 24 +++++ doc/flow.svg | 235 +++++++++++++++++++++++++++++++++++++++++++ doc/flow.tikz | 29 ++++++ doc/template-qtikz.tex | 15 +++ doc/template-tex.tex | 15 +++ kicad/kicad-utils.pro | 32 ++++++ templates/nodemcu-arduino.py | 28 +++--- thirdparty/antlr4 | 1 + 12 files changed, 446 insertions(+), 15 deletions(-) create mode 100644 README.md create mode 100644 doc/CMakeLists.txt create mode 100644 doc/flow.svg create mode 100644 doc/flow.tikz create mode 100644 doc/template-qtikz.tex create mode 100644 doc/template-tex.tex create mode 100644 kicad/kicad-utils.pro create mode 160000 thirdparty/antlr4 diff --git a/.gitmodules b/.gitmodules index 83b6a4d..50c8663 100644 --- a/.gitmodules +++ b/.gitmodules @@ -5,3 +5,6 @@ [submodule "python/pybind11"] path = python/pybind11 url = https://github.com/pybind/pybind11 +[submodule "thirdparty/antlr4"] + path = thirdparty/antlr4 + url = https://github.com/trygvis/antlr4 diff --git a/CMakeLists.txt b/CMakeLists.txt index 3b4c6e1..58d3aa4 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -8,5 +8,6 @@ add_compile_options(-Wextra) add_subdirectory(core) add_subdirectory(python) add_subdirectory(cli) +add_subdirectory(doc) #add_subdirectory(examples) diff --git a/README.md b/README.md new file mode 100644 index 0000000..af174b6 --- /dev/null +++ b/README.md @@ -0,0 +1,76 @@ +Kicad utils contains utilities for automating your Kicad workflow. + +# generate-header + +Generate header is a tool to generate header files from your schematics to ensure that your schematic and +pin mapping always is correct. + +![flow] + +[flow]: doc/flow.svg "Flow with generate-header" + +## Command line usage + +You can use the generate-header tool as a standalone command line tool like this: + + generate-header -n schematic/foo.net -r U1 -t intel-quark-d2000 -o firmware/schematic.h + +The usage is summarized like this: + + usage: generate-header -n -r -t