Skip to content
Snippets Groups Projects
Commit 38cd2ba8 authored by Krisjanis Rijnieks's avatar Krisjanis Rijnieks :lion_face:
Browse files

Update README

parent fcee5bdd
No related branches found
No related tags found
No related merge requests found
...@@ -6,25 +6,25 @@ This library (should) cover all the electronics components found in the official ...@@ -6,25 +6,25 @@ This library (should) cover all the electronics components found in the official
## Installation ## Installation
> Make sure you have at KiCad 6 or greater installed. > Make sure you have at KiCad 7 or greater installed.
1. Clone or download this repository. You may rename the directory to `fab`. 1. Clone or download this repository. You may rename the directory to `fab`.
2. Store it in a safe place such as `~/kicad/libraries` or `C:/kicad/libraries`. 2. Store it in a safe place such as `~/kicad/libraries` or `C:/kicad/libraries`.
3. Run KiCad or open a KiCad `.pro` file. 3. Run KiCad or open a KiCad `.pro` file.
4. Go to "Preferences / Manage Symbol Libraries" and add `fab.kicad_sym` as symbol library. 4. Go to "Preferences / Manage Symbol Libraries" and add `fab.kicad_sym` as symbol library.
5. Go to "Preferences / Manage Footprint Libraries" and add `fab.pretty` as footprint library. 5. Go to "Preferences / Manage Footprint Libraries" and add `fab.pretty` as footprint library.
6. Go to "Preferences / Configure Paths" and add variable named **FAB** that points to the installation directory of the fab library, such as `~/kicad/libraries/fab` or `C:/kicad/libraries/fab`. This will enable the custom 3D shapes to be found. The 3D shapes project has just started and most of them have to be populated still.
## On-Going TODO ## ToDo
- [x] Create a test script that checks if parts from fab inventory are included - [ ] Create a test script that checks if parts from fab inventory are included
- [ ] Make sure all parts from the inventory are there - [ ] Make sure all parts from the inventory are there
- [ ] Fix symbols and footprints according to KLC tests using [KiCad Library Utilities](https://gitlab.com/kicad/libraries/kicad-library-utils) - [ ] Fix symbols and footprints according to KLC tests using [KiCad Library Utilities](https://gitlab.com/kicad/libraries/kicad-library-utils)
- [ ] Review symbol and footprint local naming conventions - [ ] Review symbol and footprint local naming conventions
- [ ] Add 3D models for all parts
## Contributing ## Contributing
Please refer to the [CONTRIBUTING](CONTRIBUTING.md) document. Run `test.py` locally before `git push`. Please refer to the [CONTRIBUTING](CONTRIBUTING.md) document.
## License ## License
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment