update README

README.md

@@ -1,12 +1,12 @@
-[![kibot](https://github.com/nerdyscout/KiBot-CICD-Template/actions/workflows/kibot.yml/badge.svg)](https://github.com/nerdyscout/KiBot-CICD-Template/actions/workflows/kibot.yml)
-[![platformio](https://github.com/nerdyscout/KiBot-CICD-Template/actions/workflows/platformio.yml/badge.svg)](https://github.com/nerdyscout/KiBot-CICD-Template/actions/workflows/platformio.yml)
-[![reuse](https://github.com/nerdyscout/KiBot-CICD-Template/actions/workflows/reuse.yml/badge.svg)](https://github.com/nerdyscout/KiBot-CICD-Template/actions/workflows/reuse.yml)
+[![kibot](https://github.com/nerdyscout/KiCAD-CICD-Template/actions/workflows/kibot.yml/badge.svg)](https://github.com/nerdyscout/KiBot-CICD-Template/actions/workflows/kibot.yml)
+[![platformio](https://github.com/nerdyscout/KiCAD-CICD-Template/actions/workflows/platformio.yml/badge.svg)](https://github.com/nerdyscout/KiBot-CICD-Template/actions/workflows/platformio.yml)
+[![reuse](https://github.com/nerdyscout/KiCAD-CICD-Template/actions/workflows/reuse.yml/badge.svg)](https://github.com/nerdyscout/KiBot-CICD-Template/actions/workflows/reuse.yml)
 
 ---
 
-# KiBot-CICD-Template
+# KiCAD-CICD-Template
 
-This repository provides different CI/CD workflows with GitHub actions.
+This repository provides different CI/CD workflows used for projects using [KiCAD](https://www.kicad.org/) and [PlatformIO](https://www.platformio.org).
 
 ## workflows
 
@@ -19,30 +19,30 @@ Whenever a file matching `pcb/*.kicad_*` changes this workflow will trigger.
 The following documents are generated on every build:
 
 ```
-- cad/
+- pcb/cad/
    - dxf/
       - AutoCAD - DXF
    - boardview - BRD
    - 3D render - STEP
-- docs/
+- pcb/docs/
    - bom/
       - Interactive BOM - HTML
       - Octopart list - CSV
       - KiCost - XLSX (disabled)
    - schematic - PDF
-- img/
+- pcb/img/
    - pcb/$fab/$style/
       - PCB top - SVG
       - PCB bottom - SVG
    - render/ (disabled)
       - PCB render - PNG
    - schematic - SVG
-- gerbers - ZIP
+- pcb/gerbers - ZIP
 ```
 
 ### PlatformIO
 
-used to build your source code.
+used to rebuild your source code whenever it changes.
 
 ### REUSE
 
@@ -52,10 +52,13 @@ used to insure every file got a propper license.
 
 - [ ] hit the "use this template" button and give your project a name
 - [ ] clone this new repository localy
-- [ ] change the filenames in `pcb/` matching your repository name
-- [ ] replace the README.md
-- [ ] make sure the licenses of `pcb/*` fit your needs
-- [ ] make sure the licenses of `src/*`, `include/*`, `lib/*`, `test/*` fit your needs
-- [ ] commit all those changes
-- [ ] create your PCB
-- [ ] commit and push your project
+- [ ] replace content of README.md
+- [ ] Code
+   - [ ] put your code in the `src/` folder using platformio
+- [ ] PCB
+   - [ ] change the filenames in `pcb/*.kicad_*` matching your repository name
+   - [ ] create your PCB
+- [ ] run `reuse --lint`
+   - [ ] make sure the licenses of `pcb/*` fits your needs
+   - [ ] make sure the licenses of `src/*`, `include/*`, `lib/*`, `test/*` fits your needs
+- [ ] commit and push all those changes regulary to your project