README.md
Hi there, this file is used to initialize a repository. You can delete it if you want to.

The structure of the repository will involve submodules. The submodules will contain all of the libraries. There will be 3 submodules included each corresponding to a directory for STM related boards, telemetry related board library, and power board library.

The repo will have different branches corresponding to what is getting implemented. PLEASE DO NOT NAME BRANCHES WITH YOUR NAME.

Solar Car KiCad Project Repository

Overview

This repository contains multiple KiCad projects and shared libraries that are used for the development of the Solar Car project.

Directory Structure


projects/: Contains all KiCad project files.
KiCadLibraries/: Contains shared libraries (included as a submodule).


Getting Started

1. Clone the Repository


git clone \
cd \
git submodule update --init --recursive


2. Open a Project in KiCad


Open KiCad and navigate to the projects/ directory.
Select and open the desired project file.


3. Configure Library Paths in KiCad


Open KiCad and go to Preferences > Manage Symbol Libraries and Preferences > Manage Footprint Libraries.
Add the paths to the libraries located in the KiCadLibraries/ directory. Use the library's directory name for the Nickname. For example:


Symbol Libraries: ${KIPRJMOD}/../../../KiCadLibraries/UVA_SolarCar_HI/Samacsys_kicad_sym.kicad_sym


Enter Nickname this "UVA_SolarCar_HI"

Footprint Libraries: ${KIPRJMOD}/../../../KiCadLibraries/UVA_SolarCar_HI/SamacSys_Parts.pretty


Enter Nickname this "UVA_SolarCar_HI"




Working with the Repository

1. Pull the Latest Changes

Before making any changes, ensure your local repository is up to date:
- git pull
- git submodule update --recursive --remote

2. Make Changes


Modify the project files or libraries as needed.


3. Commit and Push Changes


Add, commit, and push your changes to the main repository:


git add .
git commit -m "Your commit message"
git push origin \



4. Update the Submodule (if applicable)

If you've made changes to the KiCadLibraries:
- cd KiCadLibraries
- git add .
- git commit -m "Updated libraries"
- git push origin 
- cd ..
- git add KiCadLibraries
- git commit -m "Updated submodule reference"
- git push origin 

Working with others


Pushing a lock file will prevent others from changing the file until you are done working
When you have finished working remove the lock file (ends with .lck)


Additional Notes


Ensure that all changes to the libraries are reflected in the main repository by updating the submodule reference.
Always work on a new branch for your changes and submit a pull request for review.
Please be careful when working with changing items in the KiCad Libraries.