From e4444b71b96c896690817a02cf66199183b68a19 Mon Sep 17 00:00:00 2001
From: Trygve Laugstøl <trygvis@inamo.no>
Date: Fri, 19 Aug 2016 08:06:17 +0200
Subject: o Adding complete documentation for the kicad_generate_header goal.
 kicad_generate_header: Append the global variable `KICAD_GEN_TEMPLATE_LIBS`
 to the template search list. o Adding back the examples.

---
 README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index b9a1bdf..d019c9e 100644
--- a/README.md
+++ b/README.md
@@ -34,6 +34,33 @@ Put this in your `CMakeLists.txt`:
 and `schematic.h` will automatically be generated. CMake now knows that `schematic.h` is generated and depends on 
 `schematic/intel-quark-d2000.net`.
 
+### CMake function usage
+
+Usage:
+
+    kicad_generate_header(
+      NET                       <netlist>                       (Required)
+      OUTPUT                    <file name>                     (Required)
+      REF                       <netlist reference>             (Required)
+      TEMPLATE                  <template name>                 (Required)
+      OUTPUT_DIR                <output base directory>
+      TEMPLATE_LIB_LIST         <template library search path>
+      TARGET                    <target name>
+      ALL
+      IN_SOURCE
+    )
+
+
+The `OUTPUT_DIR` defaults to `CMAKE_CURRENT_BINARY_DIR` unless `IN_SOURCE` is given. If so, it defaults to
+`CMAKE_CURRENT_SOURCE_DIR`.
+
+If `TARGET` is set a CMake target with the given name is created. If `ALL` is specified this target will be a part of 
+the CMake `ALL` target. See the documentation for `add_custom_target`'s `ALL` option.
+
+`TEMPLATE_LIB_LIST` is a list of directories that will be searched for the template. The global variable
+`KICAD_GEN_TEMPLATE_LIBS` will be appended to the library list if set.
+
+
 # Templates
 
 The templates are simply Python files that map from the part's pin number to a platform-specific symbol. The 
-- 
cgit v1.2.3