From 5ec88924572a2aa40f24a55238b4076bd010d9a7 Mon Sep 17 00:00:00 2001 From: "Salvador E. Tropea" Date: Fri, 25 Mar 2022 12:25:23 -0300 Subject: [PATCH] Updated docs for the GitHub action. --- README.md | 3 ++- docs/README.in | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 38143283..51286548 100644 --- a/README.md +++ b/README.md @@ -2682,11 +2682,12 @@ Another example, but using variants can be found [here](https://github.com/INTI- The available options are: -- **config**: The KiBot config file to use. Must be specified. +- **config**: The KiBot config file to use. The first file that matches `*.kibot.yaml` is used when omitted. - **dir**: Output directory for the generated files. The current directory is used when omitted. - **board**: Name of the PCB file. The first file that matches `*.kicad_pcb` is used when omitted. - **schema**: Name of the schematic file. The first file that matches `*.*sch` is used when omitted. - **skip**: Skip preflights, comma separated or *all*. Nothing is skipped when omitted. +- **targets**: List of targets to generate separated by spaces. To only run preflights use __NONE__. All targets are generated when omitted. - **variant**: Global variant to use. No variant is applied when omitted. - **verbose**: Level of verbosity. Valid values are 0, 1, 2 or 3. Default is 0. diff --git a/docs/README.in b/docs/README.in index e1b902b8..9269ede4 100644 --- a/docs/README.in +++ b/docs/README.in @@ -1136,11 +1136,12 @@ Another example, but using variants can be found [here](https://github.com/INTI- The available options are: -- **config**: The KiBot config file to use. Must be specified. +- **config**: The KiBot config file to use. The first file that matches `*.kibot.yaml` is used when omitted. - **dir**: Output directory for the generated files. The current directory is used when omitted. - **board**: Name of the PCB file. The first file that matches `*.kicad_pcb` is used when omitted. - **schema**: Name of the schematic file. The first file that matches `*.*sch` is used when omitted. - **skip**: Skip preflights, comma separated or *all*. Nothing is skipped when omitted. +- **targets**: List of targets to generate separated by spaces. To only run preflights use __NONE__. All targets are generated when omitted. - **variant**: Global variant to use. No variant is applied when omitted. - **verbose**: Level of verbosity. Valid values are 0, 1, 2 or 3. Default is 0.