Change phrasing in README (#3)

Reviewed-on: #3
Co-authored-by: Andreas Tsouchlos <an.tsouchlos@gmail.com>
Co-committed-by: Andreas Tsouchlos <an.tsouchlos@gmail.com>

.gitattributes

@@ -0,0 +1,7 @@
+*.csv filter=bom_csv
+*.html filter=bom_html
+*.gbr filter=gerber
+*.gbrjob filter=gbrjob
+*.xml filter=xml
+*.kicad_pcb filter=kicad_pcb_f
+*.net filter=net_filter

.gitconfig

@@ -0,0 +1,20 @@
+[filter "bom_csv"]
+	clean = sed -E 's/^BoM Date:.*$/BoM Date:Date/'
+	smudge = sed -E \"s/BoM Date:Date/BoM Date:,`date +\\\"%a %d %b %Y %X %:::z\\\"`/\"
+[filter "bom_html"]
+	clean = sed -E 's/^<tr><td>BoM Date<\\/td><td>.*$/<tr><td>BoM Date<\\/td><td>Date<\\/td><\\/tr>/'
+	smudge = sed -E \"s/<tr><td>BoM Date<\\/td><td>Date<\\/td><\\/tr>/<tr><td>BoM Date<\\/td><td>`date +\\\"%a %d %b %Y %X %:::z\\\"`<\\/td><\\/tr>/\"
+[filter "gerber"]
+	clean = sed -E -e 's/^%TF.CreationDate,.*$/%TF.CreationDate,Date%/' -e 's/^G04 Created by KiCad.*$/G04 Created by KiCad*/'
+	smudge = sed -E \"s/%TF.CreationDate,Date%/%TF.CreationDate,`date +%Y-%m-%dT%H:%M:%S%:z`/\"
+[filter "gbrjob"]
+	clean = sed -E 's/\"CreationDate\":.*/\"CreationDate\":  \"Date\"/'
+	smudge = sed -E \"s/\\\"CreationDate\\\":  \\\"Date\\\"/\\\"CreationDate\\\":  \\\"`date +%Y-%m-%dT%H:%M:%S%:z`\\\"/\"
+[filter "xml"]
+	clean = sed -E -e 's/^        <date>.*<\\/date>/        <date>Date2<\\/date>/' -e 's/^    <date>.*<\\/date>/    <date>Date1<\\/date>/'
+	smudge = sed -E -e \"s/<date>Date1<\\/date>/<date>`date +\\\"%a %d %b %Y %X %:::z\\\"`<\\/date>/\" -e \"s/<date>Date2<\\/date>/<date>`date +\\\"%Y-%m-%d\\\"`<\\/date>/\"
+[filter "kicad_pcb_f"]
+	clean = sed -E 's/\\(host pcbnew ([[:digit:]]+\\.[[:digit:]]+\\.[[:digit:]]+).*/\\(host pcbnew \\1\\)/'
+[filter "net_filter"]
+	clean = sed -E -e 's/\\(date \\\".*\\\"\\)/\\(date \\\"Date\\\"\\)/'
+	smudge = sed -E -e \"s/\\(date \\\"Date\\\"\\)/\\(date \\\"`date +\\\"%a %d %b %Y %X %:::z\\\"`\\\"\\)/\"

.gitea/workflows/doc-generation.yml

@@ -0,0 +1,23 @@
+name: docs-generation
+
+on:
+  pull_request:
+    paths:
+      - '**.kicad_sch'
+      - '**.kicad_pcb'
+      - '**.kicad_pro'
+
+jobs:
+  docs-generation:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: INTI-CMNB/KiBot@v1.8.1
+      with:
+        config: config.kibot.yaml
+        schema: 'HyperLink.kicad_sch'
+        board: 'HyperLink.kicad_pcb'
+    - name: upload results
+      uses: stefanzweifel/git-auto-commit-action@v5
+      with:
+        commit_message: 'Update Docs'

HyperLink.kicad_pro

@@ -111,9 +111,9 @@
         "other_text_thickness": 0.15,
         "other_text_upright": false,
         "pads": {
-          "drill": 0.762,
-          "height": 1.524,
-          "width": 1.524
+          "drill": 0.6,
+          "height": 2.1,
+          "width": 1.0
         },
         "silk_line_width": 0.15,
         "silk_text_italic": false,

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Andreas Tsouchlos
+
+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.

README.md

@@ -0,0 +1,19 @@
+# HyperLink
+
+A PCB for gathering data form CommonSense boards over bluetooth and
+retransmitting over wifi.
+
+After cloning, the libraries can be downloaded using
+
+```bash
+$ git submodule update --init
+```
+
+## PCB
+
+<img width=400 src="./doc/generated/HyperLink-top.svg" />
+<img width=400 src="./doc/generated/HyperLink-bottom.svg" />
+
+## Schematic
+
+<img src="./doc/generated/HyperLink-schematic.svg" />

config.kibot.yaml

@@ -0,0 +1,50 @@
+kibot:
+  version: 1
+
+outputs:
+  - name: 'schematic pdf'
+    comment: 'Schematic pdf generation'
+    type: 'pdf_sch_print'
+    dir: 'doc/generated'
+  - name: 'schematic svg'
+    comment: 'Schematic pdf generation'
+    type: 'svg_sch_print'
+    dir: 'doc/generated'
+    options:
+      background_color: true
+  - name: 'pcbdraw top svg'
+    comment: 'PCB top image generation'
+    type: 'pcbdraw'
+    dir: 'doc/generated'
+    options:
+      bottom: false
+      style: 'set-blue-cu'
+      show_components: 'none'
+  - name: 'pcbdraw top pdn'
+    comment: 'PCB top image generation'
+    type: 'pcbdraw'
+    dir: 'doc/generated'
+    options:
+      format: 'png'
+      dpi: 600
+      bottom: false
+      style: 'set-blue-cu'
+      show_components: 'none'
+  - name: 'pcbdraw bottom svg'
+    comment: 'PCB bottom image generation'
+    type: 'pcbdraw'
+    options:
+      bottom: true
+      style: 'set-blue-cu'
+      show_components: 'none'
+    dir: 'doc/generated'
+  - name: 'pcbdraw bottom png'
+    comment: 'PCB bottom image generation'
+    type: 'pcbdraw'
+    options:
+      format: 'png'
+      dpi: 600
+      bottom: true
+      style: 'set-blue-cu'
+      show_components: 'none'
+    dir: 'doc/generated'

encyclopedia_galactica

@@ -1 +1 @@
-Subproject commit 46de28b4338f25490849585832a1b887cda1c556
+Subproject commit b6f435d8b0325ed0cca0cb88337ebb0a400701c2