Public:GitHub/isc-hw-libs - Revision history

Lukeag3: /* Initial Setup */

2023-11-09T19:17:57Z

Initial Setup

Lukeag3: /* Initial Setup */

2023-11-09T19:17:05Z

Initial Setup

Adityaj5: Adityaj5 moved page GitHub/isc-hw-libs to Public:GitHub/isc-hw-libs

2021-09-11T04:27:51Z

Adityaj5 moved page GitHub/isc-hw-libs to Public:GitHub/isc-hw-libs

Jonathan: Infobox

2020-10-04T18:24:42Z

Infobox

Jonathan: File info

2020-09-23T03:21:36Z

File info

Jonathan: Complete filled out info

2020-09-23T03:17:12Z

Complete filled out info

Jonathan: image

2020-09-23T03:02:33Z

image

Jonathan: Label Info

2020-09-22T05:40:17Z

Label Info

Jonathan at 05:10, 22 September 2020

2020-09-22T05:10:58Z

Jonathan: Started working on it

2020-09-22T05:10:21Z

Started working on it

@@ Line 34: / Line 34: @@
 == Initial Setup ==
-To setup this library simply <code>git clone https://github.com/IlliniSolarCar/isc-hw-libs</code>
+To setup this repo simply <code>git clone https://github.com/IlliniSolarCar/isc-hw-libs</code>. Follow the steps in [[KiCad]] for using these libraries for PCB projects.
 == Library Files on Github ==

@@ Line 34: / Line 34: @@
 == Initial Setup ==
-For the vast majority of cases you will you be working with this repo as a submodule of the [[GitHub/PCB]] repo. Follow the setup instructions for that repo to initialize the Libraries submodule repo. Learn more about submodules at [[GitHub]].
+To setup this library simply <code>git clone https://github.com/IlliniSolarCar/isc-hw-libs</code>
 == Library Files on Github ==

← Older revision		Revision as of 18:24, 4 October 2020
Line 1:		Line 1:
		+	{{Infobox GitHub Repo\|org=IlliniSolarCar\|repo=isc-hw-libs\|status=Active\|content=ISC KiCad Libraries\|forkOrg=\|forkRepo=\|defaultBranch=master\|access=Public\|license=[https://creativecommons.org/licenses/by-sa/4.0/legalcode Creative Commons CC-BY-SA 4.0 License]\|branching=Topic / Project Branches\|maintainer=Electrical Group\|checks=* Master Reviews Required
		+	* Auto Labelling}}
		+
	Just like the KiCad boards themselves the KiCad libraries for parts are versionable files. Our Libraries are located at {{GithubRepo\|org=IlliniSolarCar\|repo=isc-hw-libs}} on GitHub. This is ''not'' a fork of the KiCad official Libraries, as we structure our repo differently and have custom things that would not be merged back upstream. Additionally, in late 2020 KiCad switched their official Libraries from GitHub to GitLab. Instead, we keep our custom parts and parts in KiCad official libraries and occasionally download the KiCad official ones to update on our repo.		Just like the KiCad boards themselves the KiCad libraries for parts are versionable files. Our Libraries are located at {{GithubRepo\|org=IlliniSolarCar\|repo=isc-hw-libs}} on GitHub. This is ''not'' a fork of the KiCad official Libraries, as we structure our repo differently and have custom things that would not be merged back upstream. Additionally, in late 2020 KiCad switched their official Libraries from GitHub to GitLab. Instead, we keep our custom parts and parts in KiCad official libraries and occasionally download the KiCad official ones to update on our repo.

← Older revision		Revision as of 03:21, 23 September 2020
Line 33:		Line 33:
	For the vast majority of cases you will you be working with this repo as a submodule of the [[GitHub/PCB]] repo. Follow the setup instructions for that repo to initialize the Libraries submodule repo. Learn more about submodules at [[GitHub]].		For the vast majority of cases you will you be working with this repo as a submodule of the [[GitHub/PCB]] repo. Follow the setup instructions for that repo to initialize the Libraries submodule repo. Learn more about submodules at [[GitHub]].

−	{{PCB Design Navbox\|collapsed=true}}	+	== Library Files on Github ==
		+	See more info on the [[GitHub/PCB]] page.
		+
		+	TL;DR: KiCad has a lot of files. Many of them do not need to be on GitHub. Listed here are the common ones that must or should not be on git.
		+
		+	===Symbol Library Files===
		+	{\| class="wikitable"
		+	!File Name / Extensions
		+	!Type
		+	!Include on Git
		+	!Description
		+	\|-
		+	\|LibraryName.dcm
		+	\|KiCad Symbol Library Descriptions
		+	\|REQUIRED
		+	\|This includes all the meta-data about the parts in the library - their data-sheet, name, descriptions, etc.
		+	\|-
		+	\|LibraryName.lib
		+	\|KiCad Symbol Library File
		+	\|REQUIRED
		+	\|This includes the actual symbol drawing and all of it's electrical characteristics including the outline, pins, pin type, etc.
		+	\|-
		+	\|LibraryName.bak
		+	\|KiCad Symbol Library Description Backup
		+	\|NEVER
		+	\|.dcm file back-up
		+	\|}
		+	===Footprint Library Files===
		+	{\| class="wikitable"
		+	!File Name / Extensions
		+	!Type
		+	!Include on Git
		+	!Description
		+	\|-
		+	\|LibraryName.pretty
		+	\|KiCad Footprint Library Folder
		+	\|REQUIRED
		+	\|This is the folder extension for a KiCad Footprint Library. Within this folder is the footprint files that make up the Library. KiCad footprint files are much to large for many parts to be in one file (like Symbol Libraries) while maintaining the ability for a human to work with it
		+	\|-
		+	\|FootprintName.kicad_mod
		+	\|KiCad Footprint File
		+	\|REQUIRED
		+	\|This is a KiCad footprint. It contains all of the information about a specific footprint
		+	\|}
		+	===3D Model Library Files===
		+	{\| class="wikitable"
		+	!File Name / Extensions
		+	!Type
		+	!Include on Git
		+	!Description
		+	\|-
		+	\|PartName.wrl
		+	\|VRML 3D Model
		+	\|REQUIRED
		+	\|This is a visual 3D model used by the 3D viewer to represent parts. We don't make models for all of our parts just major mechanical ones, KiCad provides a lot of the common stuff. This needs to be associated with a footprint (and aligned) before it is added.
		+	\|-
		+	\|PartName.stp
		+	PartName.setp
		+	\|STEP 3D Model
		+	\|REQUIRED
		+	\|This is a STEP model of a part which is used for integration with Mechanical CAD as it provides a 3D model of the part. KiCad can export 3d model of a PCB that includes all the step models for parts used on the PCB (if they exist). This needs to be associated with a footprint (and aligned) before it is added.
		+	\|}{{PCB Design Navbox\|collapsed=true}}

← Older revision		Revision as of 03:17, 23 September 2020
Line 24:		Line 24:
	[[File:KiCad Libraries Label.png\|thumb\|Red Label = Bad! (Unless you are updating the KiCad Libs)]]		[[File:KiCad Libraries Label.png\|thumb\|Red Label = Bad! (Unless you are updating the KiCad Libs)]]
	Unless you are updating the KiCad Libraries you should only ever touch the <code>schematic</code>, <code>layout.pretty</code>, and <code>packages3d</code> folders. If you touch the other KiCad libraries folder the auto-labeler will give your Pull Request the '''[https://github.com/IlliniSolarCar/isc-hw-libs/pulls?q=is%3Apr+is%3Aopen+label%3A%22kicad+libraries%22 Red "KiCad Libraries" label]'''. You don't want this! Make sure your parts are in the right place!		Unless you are updating the KiCad Libraries you should only ever touch the <code>schematic</code>, <code>layout.pretty</code>, and <code>packages3d</code> folders. If you touch the other KiCad libraries folder the auto-labeler will give your Pull Request the '''[https://github.com/IlliniSolarCar/isc-hw-libs/pulls?q=is%3Apr+is%3Aopen+label%3A%22kicad+libraries%22 Red "KiCad Libraries" label]'''. You don't want this! Make sure your parts are in the right place!
		+
		+	=== Github Checks / Actions ===
		+
		+	=== Labeler ===
		+	This is an action set-up with the [https://github.com/actions/labeler Github Provided labeler] action. It just labels the PR and does not fail. It will label repos by what is changed either <code>symbol</code>, <code>3d model</code>, <code>footprint</code>, <code>KiCad Libraries</code>, or <code>git</code> related files. It does this based on what files are edited. The KiCad Libraries should not be edited for the vast majority of PRs, so you don't want this label!
		+
		+	== Initial Setup ==
		+	For the vast majority of cases you will you be working with this repo as a submodule of the [[GitHub/PCB]] repo. Follow the setup instructions for that repo to initialize the Libraries submodule repo. Learn more about submodules at [[GitHub]].
		+
		+	{{PCB Design Navbox\|collapsed=true}}

← Older revision		Revision as of 03:02, 23 September 2020
Line 5:		Line 5:

	=== Branch Structure ===		=== Branch Structure ===
		+	[[File:GitHub Hardware Branches Chart.png\|thumb\|A simple chart of branches in the PCB and Hardware Libraries Repos]]
	Just like PCBs, making a footprint is not really a collaborative project like code. Multiple people can't work on something at the same time - it can't be merged. Therefore this repo is also just for versioning. When you need a new part create a branch and create that part (or multiple parts if you have multiple at the same time) and then open a PR to get it on master. Branches on the hardware libraries are often short lived. There are no longstanding development branches.		Just like PCBs, making a footprint is not really a collaborative project like code. Multiple people can't work on something at the same time - it can't be merged. Therefore this repo is also just for versioning. When you need a new part create a branch and create that part (or multiple parts if you have multiple at the same time) and then open a PR to get it on master. Branches on the hardware libraries are often short lived. There are no longstanding development branches.

← Older revision		Revision as of 05:40, 22 September 2020
Line 21:		Line 21:

	=== Making Changes ===		=== Making Changes ===
−	Unless you are updating the KiCad Libraries you should only ever touch the <code>schematic</code>, <code>layout.pretty</code>, and <code>packages3d</code> folders. If you touch the other KiCad libraries folder the auto-labeler will give your Pull Request the '''[https://github.com/IlliniSolarCar/isc-hw-libs/pulls?q=is%3Apr+is%3Aopen+label%3A%22kicad+libraries%22 Red "KiCad Libraries" label]'''. You don't want this!	+	[[File:KiCad Libraries Label.png\|thumb\|Red Label = Bad! (Unless you are updating the KiCad Libs)]]
		+	Unless you are updating the KiCad Libraries you should only ever touch the <code>schematic</code>, <code>layout.pretty</code>, and <code>packages3d</code> folders. If you touch the other KiCad libraries folder the auto-labeler will give your Pull Request the '''[https://github.com/IlliniSolarCar/isc-hw-libs/pulls?q=is%3Apr+is%3Aopen+label%3A%22kicad+libraries%22 Red "KiCad Libraries" label]'''. You don't want this! Make sure your parts are in the right place!

← Older revision		Revision as of 05:10, 22 September 2020
Line 21:		Line 21:

	=== Making Changes ===		=== Making Changes ===
−	Unless you are updating the KiCad Libraries you should only ever touch the <code>schematic</code>, <code>layout.pretty</code>, and <code>packages3d</code> folders. If you touch the other KiCad libraries folder the auto-labeler will give your Pull Request the [https://github.com/IlliniSolarCar/isc-hw-libs/pulls?q=is%3Apr+is%3Aopen+label%3A%22kicad+libraries%22 Red "KiCad Libraries" label]. You don't want this!	+	Unless you are updating the KiCad Libraries you should only ever touch the <code>schematic</code>, <code>layout.pretty</code>, and <code>packages3d</code> folders. If you touch the other KiCad libraries folder the auto-labeler will give your Pull Request the '''[https://github.com/IlliniSolarCar/isc-hw-libs/pulls?q=is%3Apr+is%3Aopen+label%3A%22kicad+libraries%22 Red "KiCad Libraries" label]'''. You don't want this!