Skip to content

Commit 2a24a7f

Browse files
authored
fix missing instruction to replace the path of pcb_file and add link to m2sdr as example
1 parent cf4356f commit 2a24a7f

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Also this is using kicad nightly since there is yet no kicad relase containing t
1515

1616
2. Add an new yaml in that dirctory e.g. pcb_image.yaml
1717

18-
3. Adding the configuration (you may need to replace `'refs/heads/main'` with `'refs/heads/master'` on older repos)
18+
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)
1919
```yaml
2020
name: pcb_image
2121
on:
@@ -31,7 +31,7 @@ Also this is using kicad nightly since there is yet no kicad relase containing t
3131
- name: render pcb image
3232
uses: linalinn/kicad-render@main
3333
with:
34-
pcb_file: m2sdr.kicad_pcb
34+
pcb_file: <path from repo root to .kicad_pcb>
3535
output_path: ${{ github.workspace }}/images
3636

3737
- name: Setup Pages
@@ -80,6 +80,9 @@ Also this is using kicad nightly since there is yet no kicad relase containing t
8080

8181
5. git commit and push
8282

83+
### Example
84+
You can find a example [here in the m2sdr](https://github.com/HackModsOrg/m2sdr) and the workflow for it [here](https://github.com/HackModsOrg/m2sdr/blob/master/.github/workflows/images.yaml)
85+
8386
## Animation original code
8487
The [code](https://gist.github.com/arturo182/57ab066e6a4a36ee22979063e4d5cce1) for the Animation is from [arturo182](https://github.com/arturo182)
85-
[Mastdon post with Gif and link to gist](https://mastodon.social/@arturo182/112062074668232493)
88+
[Mastdon post with Gif and link to gist](https://mastodon.social/@arturo182/112062074668232493)

0 commit comments

Comments
 (0)