diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 27 |
1 files changed, 27 insertions, 0 deletions
@@ -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 |