Skip to content

Commit a084d42

Browse files
committed
Add comprehensive README with installation instructions
1 parent 4939eb6 commit a084d42

File tree

2 files changed

+61
-1
lines changed

2 files changed

+61
-1
lines changed

README.md

Lines changed: 61 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,61 @@
1-
# kicad-templates
1+
# KiCad Template Collection
2+
3+
A collection of KiCad PCB templates optimized for different PCB manufacturing services. Currently includes templates for JLCPCB.
4+
5+
Templates come with design rules and stackups already configured to meet manufacturer specifications for optimal price-to-quality ratio.
6+
7+
## Installation
8+
9+
There are two ways to install and use these templates:
10+
11+
### Method 1: Using Plugin and Content Manager (Recommended)
12+
13+
The easiest way to install these templates is through KiCad's Plugin and Content Manager:
14+
15+
1. Open KiCad
16+
2. Go to **Plugin and Content Manager****Manage**
17+
3. Click **Add Repository**
18+
4. Add this repository URL:
19+
```
20+
https://raw.githubusercontent.com/sivakov512/kicad-pcm-index/master/repository.json
21+
```
22+
5. Click **OK**
23+
6. Find "Sivakov KiCad template collection" in the list and click **Install**
24+
7. Restart KiCad to ensure all templates are properly loaded
25+
26+
To create a project using these templates after installation:
27+
28+
1. Go to **File****New Project from Template**
29+
2. Navigate to the plugin directory:
30+
- On macOS: `~/Documents/KiCad/9.0/3rdparty/templates/com_github_sivakov512_kicad-templates`
31+
- For other operating systems, check your KiCad third-party path in **Preferences****Configure Paths****KICAD9_3RD_PARTY**
32+
3. Select the desired template from the available options
33+
34+
This method ensures that your templates will automatically update when new versions are released with fixes and new templates.
35+
36+
### Method 2: Cloning the Repository
37+
38+
Alternatively, you can clone this repository and use the templates directly without using the Plugin Manager:
39+
40+
1. Clone this repository to your local machine
41+
2. Go to **File****New Project from Template**
42+
3. Navigate to the `kicad-templates` directory within the cloned repository
43+
4. Select the desired template from the available options
44+
45+
This method makes it easier to understand the template path, but requires manual updates to get new templates and fixes.
46+
47+
## Available Templates
48+
49+
| Template | Description | Manufacturer |
50+
|----------|-------------|--------------|
51+
| **JLCPCB Low-Cost Template** | PCB template with minimum design rules for cost-effective fabrication at JLCPCB | JLCPCB |
52+
53+
![Template Selection](./docs/template_selector.png)
54+
55+
## Contribution
56+
57+
Contributions are welcome! If you have templates for other manufacturers or different configurations, please submit a pull request.
58+
59+
## License
60+
61+
This project is licensed under the terms of the [MIT License](./LICENSE).

docs/template_selector.png

996 KB
Loading

0 commit comments

Comments
 (0)