Inital commit

2026-02-17 08:39:27 -05:00
commit 1d094e6a04
81 changed files with 25739 additions and 0 deletions
--- a/kibot_resources/templates/readme.txt
+++ b/kibot_resources/templates/readme.txt
@@ -0,0 +1,71 @@
+<p align="center" width="100%">
+  <img alt="Logo" width="33%" src="Logos/dummy_logo.svg">
+</p>
+
+<h1 align="center">${BOARD_NAME}</h1>
+
+<p align="center" width="100%">
+  <a href="${GIT_URL}/actions/workflows/ci.yaml">
+    <img alt="CI Badge" src="${GIT_URL}/actions/workflows/ci.yaml/badge.svg?branch=">
+  </a>
+</p>
+
+<p align="center" width="100%">
+    <img src="Images/dummy_image.png">
+</p>
+
+***
+
+<p align="center">
+  <img alt="3D Top Angled" src="${png_3d_viewer_angled_top_outpath}" width="45%">
+&nbsp; &nbsp; &nbsp; &nbsp;
+  <img alt="3D Bottom Angled" src="${png_3d_viewer_angled_bottom_outpath}" width="45%">
+</p>
+
+***
+
+## SPECIFICATIONS
+
+| Parameter | Value | 
+| --- | --- |
+| Dimensions | ${bb_w_mm} × ${bb_h_mm} mm |
+
+***
+
+## DIRECTORY STRUCTURE
+
+    .
+    ├─ Computations       # Misc calculations
+    ├─ HTML               # HTML files for generated webpage
+    ├─ Images             # Pictures and renders
+    │
+    ├─ kibot_resources    # External resources for KiBot
+    │  ├─ colors          # Color theme for KiCad
+    │  ├─ fonts           # Fonts used in the project
+    │  ├─ scripts         # External scripts used with KiBot
+    │  └─ templates       # Templates for KiBot generated reports
+    │
+    ├─ kibot_yaml         # KiBot YAML config files
+    ├─ KiRI               # KiRI (PCB diff viewer) files
+    │
+    ├─ lib                # KiCad footprint and symbol libraries
+    │  ├─ 3d_models       # Component 3D models
+    │  ├─ lib_fp          # Footprint libraries
+    │  └─ lib_sym         # Symbol libraries
+    │
+    ├─ Logos              # Logos
+    │
+    ├─ Manufacturing      # Assembly and fabrication documents
+    │  ├─ Assembly        # Assembly documents (BoM, pos, notes)
+    │  │
+    │  └─ Fabrication     # Fabrication documents (ZIP, notes)
+    │     ├─ Drill Tables # CSV drill tables
+    │     └─ Gerbers      # Gerbers
+    │
+    ├─ Report             # Reports for ERC/DRC
+    ├─ Schematic          # PDF of schematic
+    ├─ Templates          # Title block templates
+    ├─ Testing
+    │  └─ Testpoints      # Testpoints tables      
+    │
+    └─ Variants           # Outputs for assembly variants