my-kicad-lib/README.md

80 lines
2.5 KiB
Markdown

# My Personal KiCad Library
This library contains custom KiCad components that are not available in the standard library.
## 📁 Structure
```
my-kicad-libs/
├── symbols/ # Symbol libraries (.kicad_sym)
│ ├── Custom_Logic/
│ ├── Custom_Power/
│ ├── Custom_Connectors/
│ ├── Logos_Artwork/
│ └── ...
├── footprints/ # Footprint libraries (.pretty)
│ ├── Custom_QFN.pretty/
│ ├── Custom_BGA.pretty/
│ ├── Logos_Silkscreen.pretty/
│ └── ... # Only custom footprints, standard uses KiCad libs
├── 3d_models/ # 3D models (.step, .wrl)
│ ├── Connectors/
│ ├── IC_Packages/
│ ├── Mechanical/
│ └── ...
├── datasheets/ # Datasheets (optional)
├── docs/ # Documentation
├── scripts/ # Automation scripts
└── templates/ # Project templates
```
## 🏷️ Naming Conventions
### Symbols (.kicad_sym files)
- **Format**: `[Category]_[Manufacturer]_[Series].kicad_sym`
- **Examples**:
- `Logic_TI_74HC.kicad_sym`
- `Power_LTC_Switching.kicad_sym`
- `Connectors_JST_XH.kicad_sym`
- `Logos_Personal.kicad_sym`
### Individual Symbol Names (within .kicad_sym)
- **Format**: `[Partnumber]_[Package]_[Variant]`
- **Examples**:
- `TPS54340_HTSSOP-14_PowerPAD`
- `STM32F407VGT6_LQFP-100`
- `USB-C_16Pin_Receptacle`
- `Logo_MyCompany_10mm`
### Footprints (.pretty folders)
**Note**: Standard passives and common ICs use existing KiCad footprints!
- **Format**: `[Category]_[Specification].pretty`
- **Examples**:
- `QFN_Custom.pretty`
- `USB_Connectors.pretty`
- `Logos_Silkscreen.pretty`
- `Mechanical_Standoffs.pretty`
## ⚙️ Best Practices
### Component Strategy
1. **Use KiCad footprints**: Don't reinvent the wheel for standard packages
2. **Consistent naming**: Follow established naming conventions
3. **Documentation**: Include manufacturer data and datasheets
4. **Quality**: Test all components before adding to library
### Workflow
#### Adding New Component
1. **Check KiCad**: Verify symbol/footprint don't exist in standard libraries
2. **Research**: Find datasheet and manufacturer information
3. **Create symbol**: With complete manufacturer data
4. **Link footprint**: Use existing KiCad footprint or create custom
5. **Test**: Use in test circuit
6. **Document**: Add to documentation
---
*Last update: December 9, 2024*