Skip to content

Latest commit

 

History

History
84 lines (63 loc) · 3.22 KB

README.md

File metadata and controls

84 lines (63 loc) · 3.22 KB

downloads discord

MainsailOS

Mainsail Logo

A Raspberry Pi OS based distribution for 3d Printers. It includes everything to get started with Klipper Fimware and Mainsail.

Learn More about...
Klipper Firmware: https://www.klipper3d.org/
Moonraker: https://moonraker.readthedocs.io/en/latest/
Mainsail: https://docs.mainsail.xyz/

Installing

See the installation instructions on the Mainsail documentation page:
https://docs.mainsail.xyz/setup/mainsail-os

Community

For additional help, join us in the Mainsail Discord.

discord

What is included?

Here a list of included and preinstalled Software:

Screenshots

screenshot-dashboard

Build your own / Developing

Requirements

Packages for Ubuntu 18.04/20.04

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

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

Build your own Image of MainsailOS

git clone https://github.com/mainsail-crew/MainsailOS.git
cd MainsailOS/
make

Other make options

make clean - Clean all previous build items except the source raspian image
make distclean - Clean up the source image and trigger a new download
make cleanfix - If your build fails you, sometimes, have no Permission to clean. This will chmod to 0777 to grant full access.

Build layout

MainsailOS/emulation - Contains dependencies for emulation testing
MainsailOS/src/image - Will contain an Raspberry Pi OS Image and according sha1 checksum file MainsailOS/src/workspace - Created during build, and output for compiled Images


Credits

We want to give a shoutout to jottr for mentioning a naming convention problem.
In the past we used 'raspbian' at some points for names.
But this isn't technicaly true.
MainsailOS is based of Raspberry Pi OS, not raspbian.