Skip to content

Commit a858061

Browse files
authored
Update README.md and fix some spelling errors
1 parent ae9345b commit a858061

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

README.md

+11-10
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,20 @@
1-
# kicad render action (WIP)
1+
# kicad render action
22

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
44

55
### 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.
78

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
910

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.
1112

1213

1314
## 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.
1516

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
1718

1819
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)
1920
```yaml
@@ -65,17 +66,17 @@ Also this is using kicad nightly since there is yet no kicad relase containing t
6566
6667
4. Adding the images to an README.md
6768
```Markdown
68-
# My first pcb with automaitc image generation
69+
# My first PCB with automatic image generation
6970

7071
### Images
7172
![top](<github_username>.github.io/<repo_name>/top.png)
7273
![bottom](<github_username>.github.io/<repo_name>/bottom.png)
7374
```
7475

7576
6. Prepare the repo
76-
- Open your repo on github
77+
- Open your repo on GitHub
7778
- Open `Setting`
78-
- (Left side) click on `Pages`
79+
- (Left side) Click on `Pages`
7980
- Under `Build and deployment` select for `Source` `Github Action` from the dropdown.
8081

8182
5. git commit and push

0 commit comments

Comments
 (0)