diff --git a/README.md b/README.md index 6c238272..f6c9281c 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,10 @@ ![KiBot Logo](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/kibot_740x400_logo.png) -![Python application](https://github.com/INTI-CMNB/KiBot/workflows/Python%20application/badge.svg) -[![Coverage Status](https://coveralls.io/repos/github/INTI-CMNB/kiplot/badge.svg?branch=master)](https://coveralls.io/github/INTI-CMNB/kiplot?branch=master) +![Python application](https://img.shields.io/github/workflow/status/INTI-CMNB/KiBot/Python%20application?style=plastic) +[![Coverage Status](https://img.shields.io/coveralls/github/INTI-CMNB/kiplot?style=plastic)](https://coveralls.io/github/INTI-CMNB/kiplot?branch=master) +[![PyPI version](https://img.shields.io/pypi/v/kibot?style=plastic)](https://pypi.org/project/kibot/) + KiBot is a program which helps you to generate the fabrication and documentation files for your KiCad projects easily, repeatable, and @@ -38,7 +40,7 @@ i.e. *my_project.kibot.yaml*. The format used is [YAML](https://yaml.org/). This is basically a text file with some structure. This file can be compressed using *gzip* file format. -If you never used YAML read the following [explanation](docs/KiPlotYAML.md). +If you never used YAML read the following [explanation](https://github.com/INTI-CMNB/KiBot/blob/master/docs/KiPlotYAML.md). Note that the explanation could be useful even if you know YAML. ### The header @@ -1043,7 +1045,7 @@ kibot --list ### Command line help ``` -KiBot: Command-line Plotting for KiCad +KiBot: KiCad automation tool for documents generation Usage: kibot [-b BOARD] [-e SCHEMA] [-c CONFIG] [-d OUT_DIR] [-s PRE] diff --git a/docs/README.in b/docs/README.in index 5082f841..b53367ae 100644 --- a/docs/README.in +++ b/docs/README.in @@ -2,8 +2,10 @@ ![KiBot Logo](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/kibot_740x400_logo.png) -![Python application](https://github.com/INTI-CMNB/KiBot/workflows/Python%20application/badge.svg) -[![Coverage Status](https://coveralls.io/repos/github/INTI-CMNB/kiplot/badge.svg?branch=master)](https://coveralls.io/github/INTI-CMNB/kiplot?branch=master) +![Python application](https://img.shields.io/github/workflow/status/INTI-CMNB/KiBot/Python%20application?style=plastic) +[![Coverage Status](https://img.shields.io/coveralls/github/INTI-CMNB/kiplot?style=plastic)](https://coveralls.io/github/INTI-CMNB/kiplot?branch=master) +[![PyPI version](https://img.shields.io/pypi/v/kibot?style=plastic)](https://pypi.org/project/kibot/) + KiBot is a program which helps you to generate the fabrication and documentation files for your KiCad projects easily, repeatable, and @@ -38,7 +40,7 @@ i.e. *my_project.kibot.yaml*. The format used is [YAML](https://yaml.org/). This is basically a text file with some structure. This file can be compressed using *gzip* file format. -If you never used YAML read the following [explanation](docs/KiPlotYAML.md). +If you never used YAML read the following [explanation](https://github.com/INTI-CMNB/KiBot/blob/master/docs/KiPlotYAML.md). Note that the explanation could be useful even if you know YAML. ### The header