Skip to content

Commit

Permalink
Merge pull request #37 from upb-lea/spelling
Browse files Browse the repository at this point in the history
Spelling
  • Loading branch information
gituser789 committed Jul 16, 2024
2 parents 0b3de42 + 445ca97 commit c0fffc5
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 8 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/blank.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ name: spell check
on:
# Triggers the workflow on push or pull request events but only for the "master" branch
push:
branches: [ "master" ]
branches: [main]
pull_request:
branches: [ "master" ]
branches: [main]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,20 +23,20 @@ Note: if there is a variable `KICADx_3DMODEL_DIR`, ignore this variable and add
![](documentation/figures/3d_model_path_preferences.png)

## Adding components
The main branch ist protected. To add new components, open a new separate branch
The main branch is protected. To add new components, open a new separate branch
```
git branch my-new-branch
```
Open Kicad, add your new symbols and footprints to the library. Each symbol should have the keys `Manufacturer`, `manf#` (manufacturer order number) and `mouser#` (mouser order number). Link the footprint and the 3D model. The 3D-model filepath needs to be a relative path with the above mentioned enwironment variable. The 3D-Filepath is e.g. `${MODEL_3D}/my3dmodel.stp`. Run `git status` to see your changed files. Add the example files `symbolfile` and `my3dmodel.stp` to the staging area and commit the changes. Afterwards, use `git push` to publish the changes to the new branch.
Open KiCad, add your new symbols and footprints to the library. Each symbol should have the keys `Manufacturer`, `manf#` (manufacturer order number) and `mouser#` (mouser order number). Link the footprint and the 3D model. The 3D-model file path needs to be a relative path with the above mentioned environment variable. The 3D file path is e.g. `${MODEL_3D}/my3dmodel.stp`. Run `git status` to see your changed files. Add the example files `symbolfile` and `my3dmodel.stp` to the staging area and commit the changes. Afterwards, use `git push` to publish the changes to the new branch.
```
git add symbolfile my3dmodel.stp
git commit -m "add new component xyz and 3D-model"
git push
```
Open the github page, choose your branch and create a `pull request`.
Open the GitHub page, choose your branch and create a `pull request`.

## BOM generation
The component library is aligned to use the add-on [KiCost](https://github.com/hildogjr/KiCost). Therefore the above mentioned keys `Manufacturer`, `manf#` and `mouser#` are mandatory in the symbol. In the schematic, navigate `Tools` -> `create BOM` and run a random one, e.g. `bom_csv_grouped_by_value`. Install KiCost, navigate via terminal to your kicad project folder and enter `kicost` to your terminal. As input file, choose the `.xml` file what was created by the BOM command. After that, the KiCost BOM will be created. To get the prices and stock information from Mouser, create a Mouser API key on the Mouser homepage and enter it into the [config file](https://hildogjr.github.io/KiCost/docs/_build/singlehtml/index.html#configuration-file).
The component library is aligned to use the add-on [KiCost](https://github.com/hildogjr/KiCost). Therefore the above mentioned keys `Manufacturer`, `manf#` and `mouser#` are mandatory in the symbol. In the schematic, navigate `Tools` -> `create BOM` and run a random one, e.g. `bom_csv_grouped_by_value`. Install KiCost, navigate via terminal to your KiCad project folder and enter `kicost` to your terminal. As input file, choose the `.xml` file what was created by the BOM command. After that, the KiCost BOM will be created. To get the prices and stock information from Mouser, create a Mouser API key on the Mouser homepage and enter it into the [configuration file](https://hildogjr.github.io/KiCost/docs/_build/singlehtml/index.html#configuration-file).

## Pin labels
### Connectors
Expand All @@ -50,10 +50,10 @@ Differences:
* Type: `SMD` / `THT`
* Values: `_100R` / `__4R7` / `0R001`
* Size: `0603` / `0704` / `0403`
* Technology: Thinfilm `_THIN` / Thickfilm `THICK`
* Technology: Thin film `_THIN` / Thick film `THICK`
* `HINT`: e.g. `SHUNT`
* Derivation in percent: `_1P` / `_5P` / `10P` / `20P`
* Voltag: `75V` / `100V`
* Voltage: `75V` / `100V`

Examples:
* `R_0805_100R__THIN_20P_150V`
Expand Down
10 changes: 10 additions & 0 deletions sources/wordlist
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,13 @@ wallbox
bifilar
HEMPT
GIT
BOM
BOMs
KiCad
KiCost
findability
THT
Microcontrollers
ICs
Schmitt

0 comments on commit c0fffc5

Please sign in to comment.