docs: finishing touches

README.md

@@ -1,13 +1,269 @@
-# 🏗️ HomeRacker - The universal modular rack building system
-[![forthebadge](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxNTcuOTUzMTM2NDQ0MDkxOCIgaGVpZ2h0PSIzNSIgdmlld0JveD0iMCAwIDE1Ny45NTMxMzY0NDQwOTE4IDM1Ij48cmVjdCB3aWR0aD0iMTA2LjYyNTAwNzYyOTM5NDUzIiBoZWlnaHQ9IjM1IiBmaWxsPSIjZjZhYTRhIi8+PHJlY3QgeD0iMTA2LjYyNTAwNzYyOTM5NDUzIiB3aWR0aD0iNTEuMzI4MTI4ODE0Njk3MjY2IiBoZWlnaHQ9IjM1IiBmaWxsPSIjZmY4ZjAwIi8+PHRleHQgeD0iNTMuMzEyNTAzODE0Njk3MjY2IiB5PSIyMS41IiBmb250LXNpemU9IjEyIiBmb250LWZhbWlseT0iJ1JvYm90bycsIHNhbnMtc2VyaWYiIGZpbGw9IiNGRkZGRkYiIHRleHQtYW5jaG9yPSJtaWRkbGUiIGxldHRlci1zcGFjaW5nPSIyIj5ET1dOTE9BRDwvdGV4dD48dGV4dCB4PSIxMzIuMjg5MDcyMDM2NzQzMTYiIHk9IjIxLjUiIGZvbnQtc2l6ZT0iMTIiIGZvbnQtZmFtaWx5PSInTW9udHNlcnJhdCcsIHNhbnMtc2VyaWYiIGZpbGw9IiNGRkZGRkYiIHRleHQtYW5jaG9yPSJtaWRkbGUiIGZvbnQtd2VpZ2h0PSI5MDAiIGxldHRlci1zcGFjaW5nPSIyIj5GM0Q8L3RleHQ+PC9zdmc+)](https://makerworld.com/en/@kellervater)
+[📚 What's it for?](#use-cases) | [⚙️ How does it work?](#how-it-works) | [🌐 Free & OpenSource](#open-standard)
+
 ![HomeRacker Assembly](./img/assembly_basics_4.png)
 
-HomeRacker is a fully modular rack building system for virtually any "racking needs" (Server Rack, shoe rack, book shelf, you name it).
+HomeRacker is a fully modular 3D-printable rack-building system for virtually any “racking needs” (server rack, shoe rack, bookshelf, you name it).
 
-This repo contains the respective `scad` files for all fully customizable models as well as the documentation for the entire project which seeds the page https://homeracker.org.
+You can find all parametric and non-parametric models, as well as the `.f3d` files (like the `HomeRacker - Core`), on [Makerworld](https://makerworld.com/en/@kellervater).
 
-You can find all parametric and non-parametric models as well as the `f3d` files (like the `HomeRacker - Core`) on [Makerworld](https://makerworld.com/en/@kellervater)).
+The parametric models are available in the [HomeRacker GitHub Repository](https://github.com/kellervater/homeracker/tree/main/models).
+
+> [!NOTE]
+> The basic HomeRacker system is also referred to as `HomeRacker - Core`. Free for everyone to use, remix, and reshare.
+
+# 📑 Table of Contents
+- [🔧 Use Cases](#use-cases)
+- [✨ Features](#features)
+  - [⚙️ How it works](#how-it-works)
+    - [🛠️ Assembly Basics](#assembly-basics)
+    - [💡 Assembly Tips](#assembly-tips)
+    - [🖨️ Printing Tips](#printing-tips)
+- [📐 Tech Specs](#tech-specs)
+  - [🧱 Supports](#supports)
+  - [🔗 Connectors](#connectors)
+  - [📏 Lock Pins](#lock-pins)
+- [🌍 Open Specs](#open-specs)
+- [❓ Why the name?](#why-the-name)
+- [📜 Licensing](#-licensing)
+- [🧪 Tests](#tests)
+  - [⚠️ Disclaimer](#disclaimer)
+  - [🔬 How I tested](#how-i-tested)
+- [📋 Todos](#todos)
+
+# 🔧 Use Cases
+I created HomeRacker because I was dissatisfied with the existing solutions available online.  
+Many designs were too specific—accommodating only certain devices owned by their creators. Others supported only the 10" standard, with no flexibility for deviations, often requiring additional adapters.
+
+As I began my homelab journey in April 2025, I wanted a modular solution that could adapt and grow with my evolving needs. This would eliminate the need to purchase larger racks or completely change concepts when the original design no longer met my requirements.
+
+![xkcd: The General Problem](https://imgs.xkcd.com/comics/the_general_problem.png)
+
+As it is my nature to overengineer everything, I came up with a more generic solution to serve ANY racking need. Be it a small rack for a few Raspberry Pis, a 10" standard rack for homelabs, or even a 19" standard rack (still working on that though). You can even create bookshelves, shoe racks—or combine all of the above into an abomination of a rack.
+
+To give you an idea of how this may look (10" rack, half-constructed Pi mini-rack, bookshelf):
+
+![Real Life Example](./img/real_life_example.jpg)
+
+Aside from the basic [building blocks](#basic-building-blocks), the rack above also contains the following parts:
+
+* **10" Rack**
+  * HomeRacker - 10" Rackmount Kit (Todo: link to Makerworld model) for standard-height units
+  * Raspi 5 Mount Kit:
+    * Vertical Mount Adapter for HomeRacker
+    * Front panel for 10" racks
+  * Rackmount ears for the switch. These are fully customizable rackmount ears I created as an [OpenSCAD file](./models/rackmount_ears/rackmount_ears.scad). You can customize it directly [here](https://makerworld.com/en/models/1259227-fully-customizable-rackmount-ears#profileId-1283271).
+  * HomeRacker Airflow Kit (Todo: link to Makerworld model), which consists of:
+    * Front/back panels
+    * Side panels
+    * Bottom/top panels with air intake/exhaust grids and bores for standard fans (80/92/120mm)
+
+* **Shelf** (Build any shelf configuration you like.)
+
+# ✨ Features
+
+The `HomeRacker - Core` features:
+
+* **Fully modular** – Thanks to the support-connector system, you can scale in any direction. The only limits are material strength—and how much money, space, and time you have.
+* **3D-printable** – The entire core system is printable, and no tools are required for assembly.
+* **No supports needed** – Not a single part of the core system needs printed supports.
+* **OpenSource** – Build your own adapters and use the system in personal or commercial projects (see [Open Standard](#open-standard) and [Licensing](#-licensing) for details).
+
+## ⚙️ How it works
+> **tl;dr** Think of a rack shape you want to build, download the model (insert link), print it, assemble it, and add your own mounts/adapters/whatever-you-like.
+
+I might post a YouTube video here to show how it works.
+
+### 🛠️ Assembly Basics
+
+![Assembly Basics 4 White](./img/assembly_basics_4_white.png)
+
+Assembly is straightforward and requires no tools:
+
+1. **Prepare the components**: Download the HomeRacker - Core (❗Todo: insert link), and print all required parts. Clean off any debris.
+2. **Connect supports and connectors**: Attach connectors to supports based on your desired configuration.
+3. **Secure with Lock Pins**: Use Lock Pins to lock parts in place. They can be inserted horizontally or vertically thanks to their square profile.
+4. **Add features**: Attach panels, shelves, and other accessories as needed.
+
+### 💡 Assembly Tips
+
+> [!NOTE]
+> **Pro Tip**: I created a sample 10" Cyberpunk-themed 3D model on MakerWorld (❗Todo: insert link) for inspiration.
+
+1. Plan ahead! Otherwise, you'll end up with an army of unused parts like me:
+
+   ![Army of Parts](./img/homeracker_army.jpg)
+
+   Make a parts list:
+   * How many supports of what lengths (in `base units`)?
+   * How many connectors of each type (pull-throughs, feet, regular)?
+   * Print a ton of Lock Pins. You’ll need more than you might think. The model (❗Todo: insert link) on Makerworld should include a 100-pin plate and a [Gridfinity](https://gridfinity.xyz/) box for storage.
+
+2. Build layer by layer: Start with the base frame, add vertical supports, then stack intermediate/top frames.
+3. Make sure Lock Pins are fully inserted—gentle force might be needed.
+
+### 🖨️ Printing Tips
+
+1. If bed adhesion is sketchy: Add a brim to the supports. The small contact surface on connectors can cause print failures.
+2. Prevent warping: Keep the print bed clean and oil-free. Even a fingerprint can cause issues.
+3. When printing new filament: Make sure to calibrate the material flow!
+> [!NOTE]
+> **Pro Tip**: If you need to disassemble and the pin is stuck, push it from the other side with another pin to release it.
+
+## 📐 Tech Specs
+
+> [!NOTE]
+> For actual dimensions, check out the original Fusion `.f3d` files on Makerworld. All designs are fully parameterized for easy scaling.
+
+The system is based on 4 core measurements:
+
+1. **15mm** – The `base_unit`. Each support has 15mm x/y dimensions, with z being a multiple of 15mm.
+2. **4mm** – Side length of Lock Pins and matching holes.
+3. **2mm** – Wall thickness of connectors.
+4. **0.2mm** – Tolerance added to connector interiors for print/material variances.
+
+> These values (except tolerance) are arbitrary—just made sense during design.
+
+### 🧱 Supports
+
+Supports are the structural spine of HomeRacker.
+
+![Core Support 3D Transparent](./img/core_support_3d_transparent.png)
+
+Height is a multiple of 15mm (base units).  
+E.g.: A 3-unit support = 45mm tall, a 17-unit = 255mm.
+
+Each unit height includes a 4mm hole for a Lock Pin.
+
+* Holes match Lock Pin dimensions (no tolerance).
+* Holes are convex on x and z axes for multi-directional insertion.
+
+Schematics:
+
+**Front View**
+![Support Front View](./img/core_support_front_profile.png)
+
+**Side View**
+![Support Side View](./img/core_support_side_profile.png)
+
+**Top View**
+![Support Top View](./img/core_support_top_profile.png)
+
+### 🔗 Connectors
+
+Connectors join supports in 1 to 3 dimensions.  
+From straight extenders to 6-way junctions.
+
+![3D Shot of All Connectors](./img/3d_shot_all_connectors.png)
+
+Types:
+* **Standard** – Solid center; best for load-bearing.
+* **Pull-Through** – Open center for complex builds (e.g. 10" rack).
+* **Feet** – Solid end pieces; used as rack feet.
+
+> [!IMPORTANT]
+> Connector centers are always 1 `base_unit` in height. No offsets, no fluff.  
+> So: 2 × 3-unit supports + 1 connector = exactly 7 base units (105mm).
+
+Schematics:
+
+**Top View – Outer**
+![Connector Outer Measurements](./img/core_connector_outer_measurement.png)
+
+**Top View – Inner**
+![Connector Inner Measurements](./img/core_connector_inner_measurement.png)
+
+### 📏 lock Pins
+
+Lock Pins hold the system together.
+
+![lock Pin 3D](./img/core_lock_pin_3d.png)
+
+They rely on tension from their convex shape to stay in place.
+
+Schematics:
+
+**Top View**
+![lock Pin Top](./img/core_lock_pin_top.png)
+
+**Side View**  
+> Don’t ask why the height is 3.791mm—it works. I left it as-is.
+![lock Pin Side](./img/core_lock_pin_side.png)
+
+> I may tweak the pin grip in future versions for to make it easier to pull-out again. But the base dimensions will remain the same for compatibility.
+
+## 🌍 Open Specs
+
+I created `HomeRacker - Core` to be an open spec that any maker can build on, with (almost) no strings attached.  
+(See [Licensing](#-licensing) for more.)
+
+I encourage you to make your own models based on HomeRacker!  
+Let me know, and I’ll feature your work on this page and cross-link it on Makerworld (subject to my "very objective" approval 😄).  
+Just [create an issue](https://github.com/kellervater/homeracker/issues/new) if you want to be featured.
+
+# ❓ Why the name?
+
+After ~4 hours of research, I found all my original ideas (UniRack, OpenRack, etc.) were taken.
+
+So, "HomeRacker" was born—part practical, part tongue-in-cheek. It fits the homelab theme, but also hints at the "home-wrecking" time sink this can become.
 
 # 📜 Licensing
-* The source code in this repository is licensed under the `MIT License` (see [LICENSE](./LICENSE)).
-* All 3D models and creative assets (in /models/) are licensed under the `CC BY-NC 4.0 License` (see [/models/LICENSE](./models/LICENSE)).
+
+> [!NOTE]
+> tl;dr – Use it for ANY purpose (even commercial), but credit me and share alike!
+
+* Source code: `MIT License` ([LICENSE](./LICENSE))
+* 3D models & creative assets (`/models/`): `CC BY 4.0 License` ([/models/LICENSE](./models/LICENSE))
+
+These licenses apply to the `HomeRacker - Core` system and customizable rackmount ears.
+
+> [!IMPORTANT]
+> Other models I publish may have more restrictive licenses. This will be stated clearly on Makerworld.
+
+HomeRacker is an unregistered trademark of Patrick Pötz (kellervater), first used publicly on 12.04.2025.
+
+# 🧪 Tests
+
+Of course I tested stuff... It took ~4 months from idea to this release.  
+Look at all the prototypes:
+![Photo showing a variety of HomeRacker prototypes lined up](./img/prototypes.jpg)
+
+## ⚠️ Disclaimer
+
+> [!WARNING]
+> This project is provided “as is,” without any warranty. Use at your own risk. I’m not responsible for damage, injury, or loss caused by using this system or its parts.
+
+
+Aside from the scary warning above, I need to mention, that due to the high modularity of this system combined with limited time and resources I was of course not able to test every combination of filaments, printers, print-settings, room conditions (temperature, humidity) or to do extensive load-bearing tests.
+
+What I want to say:
+I feel like the model turned out to be really nice and versatile. That's why I shared it in the first place.
+But since I do not have control over the manufacturing conditions of any consumer of this model, I cannot give any guarantees on how your specific print will turn out in the end. There are just too much variables which not even the best model design can compensate for. (Writing this feels a bit like an upfront apology... seems like I'm a people pleaser)
+
+## 🔬 How I tested
+My setup is as follows:
+* a room temperature between 17 and 25°C
+* Humidity levels between 29% and 36% (depends on when I'm doing my laundry)
+* A BambuLab X1C printer
+* Exclusively BambuLab filament (haven't tried others yet)
+  * PLA Matte (I love the charcoal color. Looks so silky)
+  * PLA Basic
+  * ABS
+* mostly I used the Textured PEI plate. It just works (provided you regularly clean it using Isopropyl alcohol). For the rest of the time I tried out the Cold Plate Super Track (it's nice but very hard to get your prints of the plates when it cools)
+
+All above's filament types can be be combined in any possible way (just make sure you do flow calibration before using new filaments. First ABS print turned out horribly just because I forgot to click the calibration checkbox).
+E.g.: you could print a connector in ABS, a support in PLA Matte and a Lock Pin in PLA and they will just fit when being assembled.
+
+> 🛠️ **Btw:** I am not affiliated with Bambu in any way besides uploading my models to MakerWorld and occasionally making use of their Exclusive Model program. But they don't pay me for naming their products anywhere else (I wish 😉).
+
+# 📋 Todos
+* [ ] Rename Building blocks in f3d (did bad translations from german to english there)
+* [ ] Release models on MakerLab
+  * [ ] HomeRacker - Core (under above's license, non-exclusive)
+  * [ ] HomeRacker - 10" Rackmount Kit (exclusive)
+  * [ ] HomeRacker - Pi5 Mount Kit (exclusive)
+  * [x] Customizable Rackmount Ears
+  * [ ] HomeRacker - Airflow Kit (exclusive)
+  * [ ] HomeRacker - Shelf
+* [ ] Can we even call it a standard yet?
+* [ ] Contributing.md stub?
+* [ ] Quickstart Guide

_config.yml

@@ -1,4 +1,4 @@
 remote_theme: pages-themes/architect@v0.2.0
 title: HomeRacker
-description: "The universal modular rack building system"
+description: "A printable modular rack building system"
 author: "kellervater"

models/LICENSE

@@ -1,4 +1,4 @@
-Attribution-NonCommercial-ShareAlike 4.0 International
+Attribution-ShareAlike 4.0 International
 
 =======================================================================
 
@@ -54,18 +54,18 @@ exhaustive, and do not form part of our licenses.
 
 =======================================================================
 
-Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International
-Public License
+Creative Commons Attribution-ShareAlike 4.0 International Public
+License
 
 By exercising the Licensed Rights (defined below), You accept and agree
 to be bound by the terms and conditions of this Creative Commons
-Attribution-NonCommercial-ShareAlike 4.0 International Public License
-("Public License"). To the extent this Public License may be
-interpreted as a contract, You are granted the Licensed Rights in
-consideration of Your acceptance of these terms and conditions, and the
-Licensor grants You such rights in consideration of benefits the
-Licensor receives from making the Licensed Material available under
-these terms and conditions.
+Attribution-ShareAlike 4.0 International Public License ("Public
+License"). To the extent this Public License may be interpreted as a
+contract, You are granted the Licensed Rights in consideration of Your
+acceptance of these terms and conditions, and the Licensor grants You
+such rights in consideration of benefits the Licensor receives from
+making the Licensed Material available under these terms and
+conditions.
 
 
 Section 1 -- Definitions.
@@ -84,7 +84,7 @@ Section 1 -- Definitions.
      and Similar Rights in Your contributions to Adapted Material in
      accordance with the terms and conditions of this Public License.
 
-  c. BY-NC-SA Compatible License means a license listed at
+  c. BY-SA Compatible License means a license listed at
      creativecommons.org/compatiblelicenses, approved by Creative
      Commons as essentially the equivalent of this Public License.
 
@@ -108,7 +108,7 @@ Section 1 -- Definitions.
 
   g. License Elements means the license attributes listed in the name
      of a Creative Commons Public License. The License Elements of this
-     Public License are Attribution, NonCommercial, and ShareAlike.
+     Public License are Attribution and ShareAlike.
 
   h. Licensed Material means the artistic or literary work, database,
      or other material to which the Licensor applied this Public
@@ -122,15 +122,7 @@ Section 1 -- Definitions.
   j. Licensor means the individual(s) or entity(ies) granting rights
      under this Public License.
 
-  k. NonCommercial means not primarily intended for or directed towards
-     commercial advantage or monetary compensation. For purposes of
-     this Public License, the exchange of the Licensed Material for
-     other material subject to Copyright and Similar Rights by digital
-     file-sharing or similar means is NonCommercial provided there is
-     no payment of monetary compensation in connection with the
-     exchange.
-
-  l. Share means to provide material to the public by any means or
+  k. Share means to provide material to the public by any means or
      process that requires permission under the Licensed Rights, such
      as reproduction, public display, public performance, distribution,
      dissemination, communication, or importation, and to make material
@@ -138,13 +130,13 @@ Section 1 -- Definitions.
      public may access the material from a place and at a time
      individually chosen by them.
 
-  m. Sui Generis Database Rights means rights other than copyright
+  l. Sui Generis Database Rights means rights other than copyright
      resulting from Directive 96/9/EC of the European Parliament and of
      the Council of 11 March 1996 on the legal protection of databases,
      as amended and/or succeeded, as well as other essentially
      equivalent rights anywhere in the world.
 
-  n. You means the individual or entity exercising the Licensed Rights
+  m. You means the individual or entity exercising the Licensed Rights
      under this Public License. Your has a corresponding meaning.
 
 
@@ -158,10 +150,9 @@ Section 2 -- Scope.
           exercise the Licensed Rights in the Licensed Material to:
 
             a. reproduce and Share the Licensed Material, in whole or
-               in part, for NonCommercial purposes only; and
+               in part; and
 
-            b. produce, reproduce, and Share Adapted Material for
-               NonCommercial purposes only.
+            b. produce, reproduce, and Share Adapted Material.
 
        2. Exceptions and Limitations. For the avoidance of doubt, where
           Exceptions and Limitations apply to Your use, this Public
@@ -229,9 +220,7 @@ Section 2 -- Scope.
           Rights, whether directly or through a collecting society
           under any voluntary or waivable statutory or compulsory
           licensing scheme. In all other cases the Licensor expressly
-          reserves any right to collect such royalties, including when
-          the Licensed Material is used other than for NonCommercial
-          purposes.
+          reserves any right to collect such royalties.
 
 
 Section 3 -- License Conditions.
@@ -276,6 +265,7 @@ following conditions.
           reasonable to satisfy the conditions by providing a URI or
           hyperlink to a resource that includes the required
           information.
+
        3. If requested by the Licensor, You must remove any of the
           information required by Section 3(a)(1)(A) to the extent
           reasonably practicable.
@@ -287,7 +277,7 @@ following conditions.
 
        1. The Adapter's License You apply must be a Creative Commons
           license with the same License Elements, this version or
-          later, or a BY-NC-SA Compatible License.
+          later, or a BY-SA Compatible License.
 
        2. You must include the text of, or the URI or hyperlink to, the
           Adapter's License You apply. You may satisfy this condition
@@ -307,8 +297,7 @@ apply to Your use of the Licensed Material:
 
   a. for the avoidance of doubt, Section 2(a)(1) grants You the right
      to extract, reuse, reproduce, and Share all or a substantial
-     portion of the contents of the database for NonCommercial purposes
-     only;
+     portion of the contents of the database;
 
   b. if You include all or a substantial portion of the database
      contents in a database in which You have Sui Generis Database
@@ -415,6 +404,7 @@ Section 8 -- Interpretation.
      that apply to the Licensor or You, including from the legal
      processes of any jurisdiction or authority.
 
+
 =======================================================================
 
 Creative Commons is not a party to its public