Files
homeracker/README.md
kellervater bfcfa14047 docs: readme
2025-04-12 10:37:59 +02:00

41 lines
3.1 KiB
Markdown
Raw Blame History

# home-racker
![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).
This repo though contains the respective `scad` files for all fully customizable models as well as the documentation for the entire project.
Everyting else (like the `HomeRacker - Core`) you can find on my [Makerworld Page](https://makerworld.com/en/@kellervater)). There I provide all all models (which I didn't transpile into `scad`) as f3d files.
# Development
>[!NOTE]
> Everything Jekyll-related has been tested using debian-based distros (in my case Ubuntu and WSL2 Ubuntu).
## Prerequisites
### make
Install make. E.g. for debian-based OSs:
```bash
sudo apt install make
```
### asdf
You need to install [asdf](https://asdf-vm.com/guide/getting-started.html). You can do so by running the install script:
```bash
chmod +x install-asdf.sh && ./install-asdf.sh
```
This will add `asdf` and bash completion to your path.
Now you can install all plugins:
```bash
make asdf-install # due to some bug you might need to run it twice before it works
```
## Feedback?
Open an issue here rather than at Makerworld. I can track feature requests and bugs way easier here in Github.
## 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)).
<EFBFBD>