From f04079827880341e42d8043b279b10593f4d1840 Mon Sep 17 00:00:00 2001 From: "Salvador E. Tropea" Date: Fri, 28 Oct 2022 08:58:49 -0300 Subject: [PATCH] [DOCs] Added KiBot invocation example to populate doc --- docs/populate.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/populate.md b/docs/populate.md index 2ea05876..82f47f53 100644 --- a/docs/populate.md +++ b/docs/populate.md @@ -45,6 +45,16 @@ to render the images is contained in the input markdown file information comes from the KiBot configuration file, and the YAML text from the input markdown file is discarded. +You can try the above example using the following +[PCB example](../tests/data/ArduinoLearningKitStarter.kicad_pcb). +From the root of the KiBot repository you can run: + +```shell +src/kibot -c tests/yaml_samples/populate_simple.kibot.yaml -b tests/data/ArduinoLearningKitStarter.kicad_pcb -d example +``` + +Then load the generated web page: `example/PopulateSimple/index.html` + ## Source file format