Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(README): update README according to latest changes. #110

Merged
merged 7 commits into from
May 25, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 13 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
![downloads](https://img.shields.io/github/downloads/mainsail-crew/MainsailOS/total)
[![discord](https://img.shields.io/discord/758059413700345988?color=%235865F2&label=discord&logo=discord&logoColor=white&style=flat)](https://discord.gg/skWTwTD)
[![discord](https://img.shields.io/discord/758059413700345988?color=%235865F2&label=discord&logo=discord&logoColor=white&style=flat)](https://discord.gg/mainsail)

# MainsailOS

![Mainsail Logo](https://github.com/meteyou/mainsail/raw/master/docs/assets/img/logo.png?raw=true)

A [Raspberry Pi OS](https://www.raspberrypi.org/software/) based distribution for 3d Printers. It includes everything to get started with Klipper Firmware and Mainsail.
A [Raspberry Pi OS](https://www.raspberrypi.org/software/) based distribution for 3D Printers. \
It includes everything to get started with Klipper Firmware and Mainsail.

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

## Installing
Expand All @@ -19,7 +20,7 @@ https://docs.mainsail.xyz/setup/mainsail-os

## Community

For additional help, join us in the [Mainsail Discord](https://discord.gg/skWTwTD).
For additional help, join us on [Discord](https://discord.gg/mainsail).

[![discord](https://img.shields.io/discord/758059413700345988?color=%235865F2&label=discord&logo=discord&logoColor=white&style=flat)](https://discord.gg/skWTwTD)

Expand All @@ -30,9 +31,9 @@ Here a list of included and preinstalled Software:
- [Klipper (3D Printer Firmware)](https://github.com/KevinOConnor/klipper)
- [Moonraker (API Web Server for Klipper)](https://github.com/Arksine/moonraker)
- [Mainsail (Web interface for Klipper/Moonraker)](https://github.com/meteyou/mainsail)
- [Mjpeg-streamer (Webcam streaming)](https://github.com/jacksonliam/mjpg-streamer)
- [Crowsnest (Webcam streaming)](https://github.com/mainsail-crew/crowsnest)
- [Sonar (Keepalive daemon)](https://github.com/mainsail-crew/sonar)
- [Nginx (Webserver & Proxy)](https://nginx.org/en/)
- [FFMPEG (upcoming features)](https://www.ffmpeg.org/)

## Screenshots

Expand All @@ -43,17 +44,8 @@ Here a list of included and preinstalled Software:
To prevent you have to deal with an entire build chain setup, \
simply fork this repository.

Enable the workflows in your fork and you are good to go.
On every push you make, it will build an Image and upload it as artifact.

If you want or need to build locally please visit [CustomPiOS](https://github.com/guysoft/CustomPiOS)
Especcially ["Build a Distro From within Raspbian / Debian / Ubuntu / CustomPiOS Distros"](https://github.com/guysoft/CustomPiOS#build-a-distro-from-within-raspbian--debian--ubuntu--custompios-distros)

---

## Credits
Enable the workflows in your fork and you are good to go. \
On each push you make, an image is build and uploaded as an artifact.

We want to give a shoutout to [jottr](https://github.com/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.
If you want or need to build locally please visit [CustomPiOS](https://github.com/guysoft/CustomPiOS). \
Especially ["Build a Distro From within Raspbian / Debian / Ubuntu / CustomPiOS Distros"](https://github.com/guysoft/CustomPiOS#build-a-distro-from-within-raspbian--debian--ubuntu--custompios-distros)