Moved @nerdyscout changes to README.md to the README.in file.
This commit is contained in:
parent
80718531b8
commit
8605ccdea4
|
|
@ -1345,9 +1345,12 @@ In order to run KiBot on these environments you need a lot of software installed
|
|||
|
||||
For more information about the docker images visit [kicad_debian](https://github.com/INTI-CMNB/kicad_debian) and [kicad_auto](https://github.com/INTI-CMNB/kicad_auto).
|
||||
|
||||
|
||||
### Usage of Github Actions
|
||||
|
||||
You need to put a [config.kibot.yaml](#configuration) file into the KiCad project folder.
|
||||
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:
|
||||
|
||||
```yaml
|
||||
name: example
|
||||
|
|
@ -1384,6 +1387,7 @@ on:
|
|||
path: output
|
||||
```
|
||||
|
||||
|
||||
## Credits
|
||||
|
||||
- **KiBot project**: Salvador E. Tropea (@set-soft)
|
||||
|
|
@ -1394,6 +1398,6 @@ on:
|
|||
- **PcbDraw**: Jan Mrázek (@yaqwsx)
|
||||
- **Contributors**:
|
||||
- **Error filters ideas**: Leandro Heck (@leoheck)
|
||||
- **GitHub Actions Integration**: @nerdyscout
|
||||
- **GitHub Actions Integration/SVG output**: @nerdyscout
|
||||
- **Others**:
|
||||
- **Robot in the logo**: Christian Plaza (from pixabay)
|
||||
|
|
|
|||
|
|
@ -32,6 +32,7 @@ To learn more about KiBot variants visit the [example repo](https://inti-cmnb.gi
|
|||
* [Usage](#usage)
|
||||
* [Installation](#installation)
|
||||
* [Usage for CI/CD](#usage-for-cicd)
|
||||
* [Github Actions](#usage-of-github-actions)
|
||||
* [Credits](#credits)
|
||||
|
||||
## Introduction
|
||||
|
|
@ -573,6 +574,48 @@ In order to run KiBot on these environments you need a lot of software installed
|
|||
For more information about the docker images visit [kicad_debian](https://github.com/INTI-CMNB/kicad_debian) and [kicad_auto](https://github.com/INTI-CMNB/kicad_auto).
|
||||
|
||||
|
||||
### Usage of Github Actions
|
||||
|
||||
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:
|
||||
|
||||
```yaml
|
||||
name: example
|
||||
|
||||
on:
|
||||
push:
|
||||
paths:
|
||||
- '**.sch'
|
||||
- '**.kicad_pcb'
|
||||
pull_request:
|
||||
paths:
|
||||
- '**.sch'
|
||||
- '**.kicad_pcb'
|
||||
|
||||
jobs:
|
||||
example:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: INTI-CMNB/KiBot@v0.7.0
|
||||
with:
|
||||
# Required - kibot config file
|
||||
config: config.kibot.yaml
|
||||
# optional - prefix to output defined in config
|
||||
dir: output
|
||||
# optional - schematic file
|
||||
schema: '*.sch'
|
||||
# optional - PCB design file
|
||||
board: '*.kicad_pcb'
|
||||
- name: upload results
|
||||
uses: actions/upload-artifact@v2.0
|
||||
with:
|
||||
name: output
|
||||
path: output
|
||||
```
|
||||
|
||||
|
||||
## Credits
|
||||
|
||||
- **KiBot project**: Salvador E. Tropea (@set-soft)
|
||||
|
|
@ -583,6 +626,6 @@ For more information about the docker images visit [kicad_debian](https://github
|
|||
- **PcbDraw**: Jan Mrázek (@yaqwsx)
|
||||
- **Contributors**:
|
||||
- **Error filters ideas**: Leandro Heck (@leoheck)
|
||||
- **SVG output**: @nerdyscout
|
||||
- **GitHub Actions Integration/SVG output**: @nerdyscout
|
||||
- **Others**:
|
||||
- **Robot in the logo**: Christian Plaza (from pixabay)
|
||||
|
|
|
|||
Loading…
Reference in New Issue