templates
/
KiBot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #11 from hoijui/master 

README: Make navigation more easy
This commit is contained in:
Salvador E. Tropea 2020-09-09 08:40:39 -03:00 committed by GitHub
parent b03b56ae5d 2cdc959785
commit 2c86d6d646
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -6,6 +6,16 @@
[![Coverage Status](https://img.shields.io/coveralls/github/INTI-CMNB/KiBot?style=plastic)](https://coveralls.io/github/INTI-CMNB/KiBot?branch=master)
[![PyPI version](https://img.shields.io/pypi/v/kibot?style=plastic)](https://pypi.org/project/kibot/)
## Index
* [Introduction](#introduction)
* [Configuration](#configuration)
* [Usage](#usage)
* [Installation](#installation)
* [Usage for CI/CD](#usage-for-cicd)
* [Credits](#credits)
## Introduction
KiBot is a program which helps you to generate the fabrication and
documentation files for your KiCad projects easily, repeatable, and
@ -29,7 +39,7 @@ KiBot lets you do this. The following picture depicts the data flow:
![KiBot Logo](https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/Esquema.png)
## The configuration file
## Configuration
KiBot uses a configuration file where you can specify what *outputs* to
generate. By default you'll generate all of them, but you can specify which
@ -999,7 +1009,7 @@ Next time you need this list just use an alias, like this:
Not fitted components are crossed.
## Using KiBot
## Usage
If you need a template for the configuration file try:
@ -1123,7 +1133,7 @@ Options:
```
## Installing
## Installation
### Dependencies
@ -1132,7 +1142,7 @@ Options:
- For interactive BoM install [InteractiveHtmlBom](https://github.com/INTI-CMNB/InteractiveHtmlBom)
- For SVG/PNG/JPG beauty PCB render [PcbDraw](https://github.com/INTI-CMNB/PcbDraw)
### Installation on Ubuntu/Debian:
### Installation on Ubuntu/Debian
Get the Debian package from the [releases section](https://github.com/INTI-CMNB/KiBot/releases) and run:
```
@ -1146,7 +1156,7 @@ In this case the packages are also included in the release page. As an example v
sudo apt install ./python3-mcpy_2.0.2-1_all.deb ./kibot_0.6.0-1_all.deb
```
### Installation using pip:
### Installation using pip
```
pip install --no-compile kibot
@ -1163,7 +1173,7 @@ There is no advantage in doing it and it interferes with the `mcpy` macros.
- Run the script *src/kibot*
## Using for CI/CD
## Usage for CI/CD
When using a GitHub or GitLab repo you can use KiBot to generate all the needed stuff each time you commit a change to the schematic and/or PCB file.