Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
odinthenerd authored Dec 5, 2023
0 parents commit 446e1a1
Show file tree
Hide file tree
Showing 13 changed files with 1,556 additions and 0 deletions.
67 changes: 67 additions & 0 deletions .github/workflows/KiCad.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
name: "KiCAD Action"

on:
push:
tags:
- '*'

jobs:
quick:
name: "Quick Start (action)"
runs-on: ubuntu-latest

steps:
- name: Get repo
uses: actions/checkout@v3

- name: Run KiBot
uses: INTI-CMNB/KiBot@v2_k6
with:
quickstart: YES

- name: Zip It
uses: montudor/action-zip@v1
with:
args: zip -qq -r production.zip Generated

- name: Rename JLC Package
run: cp Generated/Manufacturers/*JLCPCB.zip jlcpcb.zip

- name: Rename ibom
run: cp Generated/Assembly/*ibom.html assembly-ibom.html

- name: Rename 3D View
run: cp Generated/3D/*30deg.png topview.png

- name: Rename BoM
run: cp Generated/BoM/Generic/*.csv bom.csv

- name: Make Release
uses: softprops/action-gh-release@v1
with:
files: |
production.zip
jlcpcb.zip
assembly-ibom.html
topview.png
bom.csv
- name: Publish commit hash to mqtt broker
uses: juhrlass/mqtt-action@master
with:
protocol: mqtt
host: public.mqtt.gruppe.ai
port: 1883
topic: "skunkforce/CI/KiCAD/${{ github.repository }}"
message: '{
"action" : "KiCAD CI-Task successfully run!",
"repo" : "${{ github.repository }}",
"tag" : "${{ github.ref_name }}",
"actor" : "${{ github.actor }}",
"commit" : "${{ github.event.head_commit.message }}",
"picture" : "https://github.com/${{ github.repository }}/releases/download/${{ github.ref_name }}/topview.png",
"bom" : "https://github.com/${{ github.repository }}/releases/download/${{ github.ref_name }}/bom.csv",
"assembly" : "https://github.com/${{ github.repository }}/releases/download/${{ github.ref_name }}/assembly-ibom.html",
"jlcpcb-pack" : "https://github.com/${{ github.repository }}/releases/download/${{ github.ref_name }}/jlcpcb.zip",
"download" : "https://github.com/${{ github.repository }}/releases/download/${{ github.ref_name }}/production.zip"
}'
28 changes: 28 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# For PCBs designed using KiCad: http://www.kicad-pcb.org/
# Format documentation: http://kicad-pcb.org/help/file-formats/

# Temporary files
*.000
*.bak
*.bck
*.kicad_pcb-bak
*.sch-bak
*~
_autosave-*
*.tmp
*-save.pro
*-save.kicad_pcb
fp-info-cache
board-backups/
*.kicad_prl

# Netlist files (exported from Eeschema)
*.net

# Autorouter files (exported from Pcbnew)
*.dsn
*.ses

# Exported BOM files
*.xml
*.csv
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "put_on_edge"]
path = put_on_edge
url = https://github.com/skunkforce/put_on_edge
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2023 open skunk force

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# edgy_board number b123
This design is part of the [edgy board project](https://github.com/skunkforce/edgy_boards). It provides the functionality of chip XXXX via interfaces YYYY.

![](/board/board.png)

# getting started
This repository uses submodules. After cloning use the command

```$ git submodule update --init --recursive```

to pull the submodules before opening the project with kicad.

# Tests
Tests can be found in [TESTS.md](TESTS.md)

12 changes: 12 additions & 0 deletions TESTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# test 1
## setup
Describe your test setup
## results
Describe your results


# test 2
## setup
Describe your test setup
## results
Describe your results
Loading

0 comments on commit 446e1a1

Please sign in to comment.