From 87a9d966a3fe2712892c0466866ed08e76808bb4 Mon Sep 17 00:00:00 2001 From: "Salvador E. Tropea" Date: Mon, 2 May 2022 13:40:17 -0300 Subject: [PATCH] Added link to GitHub action with --quick-start --- README.md | 3 +++ docs/README.in | 3 +++ 2 files changed, 6 insertions(+) diff --git a/README.md b/README.md index 4f947b8b..9fa670ca 100644 --- a/README.md +++ b/README.md @@ -3026,6 +3026,8 @@ For more information about the docker images visit [kicad_debian](https://github ### Usage of Github Actions +Note: You can also use --quick-start functionality with GitHub actions, and example is this [workflow](https://github.com/INTI-CMNB/kibot_variants_arduprog/blob/master/.github/workflows/kibot_action_quick_start.yml) + You need to put a [config.kibot.yaml](#configuration) file into the KiCad project folder. Here is an example of workflow file using the GitHub Action: @@ -3078,6 +3080,7 @@ The available options are: - **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. +- **quickstart**: When `YES` ignores all the other options and runs in `--quick-start` mode. No configuration needed. - **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. diff --git a/docs/README.in b/docs/README.in index c5fb2d2d..ff5e8f07 100644 --- a/docs/README.in +++ b/docs/README.in @@ -1282,6 +1282,8 @@ For more information about the docker images visit [kicad_debian](https://github ### Usage of Github Actions +Note: You can also use --quick-start functionality with GitHub actions, and example is this [workflow](https://github.com/INTI-CMNB/kibot_variants_arduprog/blob/master/.github/workflows/kibot_action_quick_start.yml) + You need to put a [config.kibot.yaml](#configuration) file into the KiCad project folder. Here is an example of workflow file using the GitHub Action: @@ -1334,6 +1336,7 @@ The available options are: - **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. +- **quickstart**: When `YES` ignores all the other options and runs in `--quick-start` mode. No configuration needed. - **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.