# RatOS

**Repository Path**: blueair2006/RatOS

## Basic Information

- **Project Name**: RatOS
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-05-24
- **Last Updated**: 2024-05-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

![RatOS](site/static/img/logos/Logo-black.svg)

<p align="center">
<a href="https://github.com/Rat-OS/RatOS/releases"><img src="https://img.shields.io/github/downloads/Rat-OS/RatOS/total?color=%2368da0b" /></a>
<a href="http://discord.gg/ratrig"><img src="https://img.shields.io/discord/582187371529764864?color=%235865F2&label=discord&logo=discord&logoColor=white&style=flat" /></a>
</p>

# What is RatOS

RatOS is a preconfigured Raspberry Pi image that aims to make it as painless as possible to get Klipper, Mainsail and Moonraker up and running on your printer. It is developed and maintained by Mikkel Schmidt (miklschmidt#2036 on the Rat Rig Unofficial Discord) with help from the community.

# How to use RatOS

Start by reading the [Documentation](https://os.ratrig.com)

# Build your own / Developing

## Requirements

-   [qemu-arm-static](http://packages.debian.org/sid/qemu-user-static)
-   [CustomPiOS](https://github.com/guysoft/CustomPiOS)
-   [Downloaded Raspbian Image](http://www.raspbian.org/)
-   Bash
-   Git
-   [Docker](https://docs.docker.com/engine/install/ubuntu/)
-   [Docker-Compose](https://docs.docker.com/compose/install/)
-   QEMU for emulation
-   About 5GB of free diskspace for the build
-   Yarn & Docusaurus for docs

### Packages for Ubuntu 18.04/20.04

** Dekstop variants are known to cause issues during build due to snaps takeing up loop mounts **

```bash
sudo apt-get install gawk make build-essential util-linux \
qemu-user-static qemu-system-arm \
git p7zip-full python3 curl
```

## Compiling source

```bash
git clone https://github.com/Rat-Rig/RatOS.git
cd RatOS/
make build
```

or without docker:

```
git clone https://github.com/guysoft/CustomPiOS.git
git clone https://github.com/Rat-OS/RatOS.git
cd RatOS/src/image wget -c --trust-server-names 'https://downloads.raspberrypi.org/raspios_lite_armhf_latest'
cd ..
../../CustomPiOS/src/update-custompios-paths
sudo modprobe loop
sudo bash -x ./build_dist
```

### Other make options

```bash
make clean - Clean all previous build items except the source raspian image
make distclean - Clean up the source image and trigger a new download
```

### Build layout

RatOS/emulation - Contains dependencies for emulation testing  
RatOS/src/image - Contains our base raspbian image  
RatOS/src/workspace - Created during build, and output for compiled images

## HUGE THANK YOU to the Sponsors

![Rat Rig](sponsors/ratrig-logo.png)

![Intermode](sponsors/intermode-logo.png)