From dd210162b7fd1ce967be6df8f590d49730f52daf Mon Sep 17 00:00:00 2001 From: "Salvador E. Tropea" Date: Sun, 13 Mar 2022 15:58:06 -0300 Subject: [PATCH] Updated docs (KiCad version for *_replace preflights) --- README.md | 2 ++ docs/samples/generic_plot.kibot.yaml | 2 ++ 2 files changed, 4 insertions(+) diff --git a/README.md b/README.md index 859fef0d..15347b8b 100644 --- a/README.md +++ b/README.md @@ -129,6 +129,7 @@ This section is used to specify tasks that will be executed before generating an - *regexp*: Alias for regex. - `ignore_unconnected`: [boolean=false] Option for `run_drc`. Ignores the unconnected nets. Useful if you didn't finish the routing. - `pcb_replace`: [dict] Replaces tags in the schematic. I.e. to insert the git hash or last revision date. + This is useful for KiCad 5, use `set_text_variables` when using KiCad 6. This pre-flight modifies the PCB. Even when a back-up is done use it carefully. * Valid keys: - `date_command`: [string=''] Command to get the date to use in the PCB.\ @@ -153,6 +154,7 @@ This section is used to specify tasks that will be executed before generating an - `run_erc`: [boolean=false] Runs the ERC (Electrical Rules Check). To ensure the schematic is electrically correct. The report file name is controlled by the global output pattern (%i=erc %x=txt). - `sch_replace`: [dict] Replaces tags in the schematic. I.e. to insert the git hash or last revision date. + This is useful for KiCad 5, use `set_text_variables` when using KiCad 6. This pre-flight modifies the schematics. Even when a back-up is done use it carefully. * Valid keys: - `date_command`: [string=''] Command to get the date to use in the SCH.\ diff --git a/docs/samples/generic_plot.kibot.yaml b/docs/samples/generic_plot.kibot.yaml index 5eea6563..311b4090 100644 --- a/docs/samples/generic_plot.kibot.yaml +++ b/docs/samples/generic_plot.kibot.yaml @@ -37,6 +37,7 @@ preflight: # [boolean=false] Option for `run_drc`. Ignores the unconnected nets. Useful if you didn't finish the routing. ignore_unconnected: false # [dict] Replaces tags in the schematic. I.e. to insert the git hash or last revision date. + # This is useful for KiCad 5, use `set_text_variables` when using KiCad 6. # This pre-flight modifies the PCB. Even when a back-up is done use it carefully. pcb_replace: date_command: "git log -1 --format='%as' -- $KIBOT_PCB_NAME" @@ -52,6 +53,7 @@ preflight: # The report file name is controlled by the global output pattern (%i=erc %x=txt). run_erc: true # [dict] Replaces tags in the schematic. I.e. to insert the git hash or last revision date. + # This is useful for KiCad 5, use `set_text_variables` when using KiCad 6. # This pre-flight modifies the schematics. Even when a back-up is done use it carefully. sch_replace: date_command: "git log -1 --format='%as' -- $KIBOT_SCH_NAME"