From c852328095f9c40fb7a8f4b344d21e911673ce60 Mon Sep 17 00:00:00 2001 From: edwin Date: Sat, 25 Nov 2023 22:41:01 +0100 Subject: [PATCH] Update 'Readme.md' --- Readme.md | 30 +++++++++++++++++++++++++++--- 1 file changed, 27 insertions(+), 3 deletions(-) diff --git a/Readme.md b/Readme.md index a9513d8..dacd239 100644 --- a/Readme.md +++ b/Readme.md @@ -14,15 +14,26 @@ Edwin and Kerem's KiCAD library. ## 1. How to use this library -This library is intended to be used as a git submodule inside a git version controlled KiCAD project. +This library can be used in two different ways. It can be used in a central position (centralized) or as part of the project (git submodule). -### 1.1 Adding the library to your KiCAD Project +### 1.1 Linking the library to your KiCad Project -Go to the desired directory where you want to place the library submodule inside your project. Ther you add KicED as submodule with the following comand. +The KicED library is intended to be linked relative to your KiCad project. This means, that you will not have absolute library links which are highly specific to each user. This can create problems when collaborating together. The KicED tools allows you to avoid this problem and work wherever you want in your directory. The only thing which must be defined in your project is the location of KicED relative to the KiCad project you are working on. This is all done by using the [KiCad environment variable](https://docs.kicad.org/7.0/en/kicad/kicad.html#kicad-environment-variables) ```${KIPRJMOD}\<...>```. +#### 1.1.1 As Git Submodule + +Go to the desired directory where you want to place the library inside your project. There you add KicED as submodule with the following comand. ```console git submodule add https://git.keydev.me/Kerem/KicED ``` + +Then go into the folder ```KicED\project_init_tool```. In this folder execute the KicED library linker tool by executing the follwing command. + +```console +python KicED_libLinker.py +``` +There follow the instructions given by the tool. Once completed successfully there should be the files ```fp-lib-table``` and ```sym-lib-table```created besides your KiCad ```*.kicad_pro``` project file. These files will be recognized by KiCad as project specific libraries and contain all the relative linkages to the KicED library. + Then open your KiCAD project and go to ```Preferences```in the top left corner and select ```Manage Symbol Libraries...```. **TODO: explain how to incorperate library into KiCAD project** @@ -35,13 +46,26 @@ You will need to add the relative KicED paths with respect to your KiCAD project - *https://www.educative.io/answers/how-to-specify-a-branch-tag-when-adding-a-git-submodule*- - *https://www.youtube.com/watch?v=lnCvyGIQong* +#### 1.1.2 As a centralized library + ### 1.2 Updating Library +#### 1.2.1 For Git Submodule + +#### 1.2.2 For centralized + # Ideas + ## Automated git pull on Pc Stratup (Winwods and Linux). + > We can maybe write a script for both of them + ## Ways of using this library +## Contribution Guidelines + +base it on Kicad -> https://klc.kicad.org/ + ### Centralized (deztached from the KiCAD Project) Library is plced at a centralized point. Best place is the besides the KiCAD projects. This saves data redundancy when working on multiple KiCAD projects.