From 60423c722e8b88ee019a332902825d7cbe2f6266 Mon Sep 17 00:00:00 2001 From: "Salvador E. Tropea" Date: Thu, 22 Dec 2022 07:44:03 -0300 Subject: [PATCH] [DOCs] Removed the use of *experimental* in the docs - Too fuzzy and confuses, added more explanation --- README.md | 4 ++-- docs/README.in | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 82ad247a..15d8e193 100644 --- a/README.md +++ b/README.md @@ -123,7 +123,7 @@ Notes: - When installing from the [Debian repo](https://set-soft.github.io/debian/) you don't need to worry about dependencies, just pay attention to *recommended* and *suggested* packages. - When installing using `pip` the dependencies marked with ![PyPi dependency](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/PyPI_logo_simplified-22x22.png) will be automatically installed. - The dependencies marked with ![Auto-download](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/auto_download-22x22.png) can be downloaded on-demand by KiBot. - Note this is experimental and is mostly oriented to 64 bits Linux systems. + Note this is poorly tested and is mostly oriented to 64 bits Linux systems. Please report problems. - The `kibot-check` tool can help you to know which dependencies are missing. - Note that on some systems (i.e. Debian) ImageMagick disables PDF manipulation in its `policy.xml` file. Comment or remove lines like this: `` (On Debian: `/etc/ImageMagick-6/policy.xml`) @@ -4661,7 +4661,7 @@ Another example, but using variants can be found [here](https://github.com/INTI- The available options are: -- **additional_args**: Additional text to add to the KiBot invocation. This is experimental and only intended for advanced use. +- **additional_args**: Additional text to add to the KiBot invocation. This is intended for advanced use, report problems. - **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. diff --git a/docs/README.in b/docs/README.in index 521a7236..36402f28 100644 --- a/docs/README.in +++ b/docs/README.in @@ -122,7 +122,7 @@ Notes: - When installing from the [Debian repo](https://set-soft.github.io/debian/) you don't need to worry about dependencies, just pay attention to *recommended* and *suggested* packages. - When installing using `pip` the dependencies marked with ![PyPi dependency](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/PyPI_logo_simplified-22x22.png) will be automatically installed. - The dependencies marked with ![Auto-download](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/auto_download-22x22.png) can be downloaded on-demand by KiBot. - Note this is experimental and is mostly oriented to 64 bits Linux systems. + Note this is poorly tested and is mostly oriented to 64 bits Linux systems. Please report problems. - The `kibot-check` tool can help you to know which dependencies are missing. - Note that on some systems (i.e. Debian) ImageMagick disables PDF manipulation in its `policy.xml` file. Comment or remove lines like this: `` (On Debian: `/etc/ImageMagick-6/policy.xml`) @@ -1459,7 +1459,7 @@ Another example, but using variants can be found [here](https://github.com/INTI- The available options are: -- **additional_args**: Additional text to add to the KiBot invocation. This is experimental and only intended for advanced use. +- **additional_args**: Additional text to add to the KiBot invocation. This is intended for advanced use, report problems. - **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.