|
1 |
| -# kicad render action (WIP) |
| 1 | +# kicad render action |
2 | 2 |
|
3 |
| -This actions allows you to automaticly render Images of your pcb and use it e.g. in a README.md |
| 3 | +This action allows you to automatically render Images of your PCB and use them e.g. in a README.md |
4 | 4 |
|
5 | 5 | ### current state
|
6 |
| -Rendering Image and Animations is working but the 3D models for kicad are missing since the offical docker image dose not contain the config that is created at first start up. |
| 6 | +~~Rendering Image and Animations is working but the 3D models for Kicad are missing since the official docker image does not contain the config that was created at the first start-up.~~ |
| 7 | +3D Models provided by Kicad are now also rendered. |
7 | 8 |
|
8 |
| -Even animation are renderd fine I wasn't able to embed them in to a README.md |
| 9 | +Even animations are rendered fine I wasn't able to embed them into a README.md |
9 | 10 |
|
10 |
| -Also this is using kicad nightly since there is yet no kicad relase containing the image rendering comand in the cli. |
| 11 | +Also, this is using Kicad nightly since there is yet no Kicad release containing the image rendering command in the CLI. |
11 | 12 |
|
12 | 13 |
|
13 | 14 | ## Usage
|
14 |
| -1. Create the dirctory `.github/workflows` if it dose not already exists. |
| 15 | +1. Create the directory `.github/workflows` if it does not already exist. |
15 | 16 |
|
16 |
| -2. Add an new yaml in that dirctory e.g. pcb_image.yaml |
| 17 | +2. Add a new yaml in that directory e.g. pcb_image.yaml |
17 | 18 |
|
18 | 19 | 3. Adding the configuration. Set the path to your .kicad_pcb file (you may need to replace `'refs/heads/main'` with `'refs/heads/master'` on older repos)
|
19 | 20 | ```yaml
|
@@ -65,17 +66,17 @@ Also this is using kicad nightly since there is yet no kicad relase containing t
|
65 | 66 |
|
66 | 67 | 4. Adding the images to an README.md
|
67 | 68 | ```Markdown
|
68 |
| - # My first pcb with automaitc image generation |
| 69 | + # My first PCB with automatic image generation |
69 | 70 |
|
70 | 71 | ### Images
|
71 | 72 | 
|
72 | 73 | 
|
73 | 74 | ```
|
74 | 75 |
|
75 | 76 | 6. Prepare the repo
|
76 |
| - - Open your repo on github |
| 77 | + - Open your repo on GitHub |
77 | 78 | - Open `Setting`
|
78 |
| - - (Left side) click on `Pages` |
| 79 | + - (Left side) Click on `Pages` |
79 | 80 | - Under `Build and deployment` select for `Source` `Github Action` from the dropdown.
|
80 | 81 |
|
81 | 82 | 5. git commit and push
|
|
0 commit comments