be2e8623b9
Presently the index page of the documentation makes no attempt to clarify what Moonraker is or even that it has anything to do with 3D printing or CNC machine control. This attempts to add a basic clarification by using the top level description from README.md. Additionally this adds a second clarification that Klipper is a "3D printer firmware" (as referenced in the Klipper `README.md`) in this projects `README.md`. Signed-off-by: Brian 'Redbeard' Harrington <redbeard@dead-city.org>
50 lines
1.9 KiB
Markdown
50 lines
1.9 KiB
Markdown
# Moonraker - API Web Server for Klipper
|
|
|
|
Moonraker is a Python 3 based web server that exposes APIs with which
|
|
client applications may use to interact with the 3D printing firmware
|
|
[Klipper](https://github.com/KevinOConnor/klipper). Communcation between
|
|
the Klippy host and Moonraker is done over a Unix Domain Socket. Tornado
|
|
is used to provide Moonraker's server functionality.
|
|
|
|
Documentation for users and developers can be found on
|
|
[Read the Docs](https://moonraker.readthedocs.io/en/latest/).
|
|
|
|
### Clients
|
|
|
|
Note that Moonraker does not come bundled with a client, you will need to
|
|
install one. The following clients are currently available:
|
|
|
|
- [Mainsail](https://github.com/mainsail-crew/mainsail) by [Mainsail-Crew](https://github.com/mainsail-crew)
|
|
- [Fluidd](https://github.com/fluidd-core/fluidd) by Cadriel
|
|
- [KlipperScreen](https://github.com/jordanruthe/KlipperScreen) by jordanruthe
|
|
- [mooncord](https://github.com/eliteSchwein/mooncord) by eliteSchwein
|
|
|
|
### Raspberry Pi Images
|
|
|
|
Moonraker is available pre-installed with the following Raspberry Pi images:
|
|
|
|
- [MainsailOS](https://github.com/mainsail-crew/MainsailOS) by [Mainsail-Crew](https://github.com/mainsail-crew)
|
|
- Includes Klipper, Moonraker, and Mainsail
|
|
- [FluiddPi](https://github.com/fluidd-core/FluiddPi) by Cadriel
|
|
- Includes Klipper, Moonraker, and Fluidd
|
|
|
|
### Docker Containers
|
|
|
|
The following projects deploy Moonraker via Docker:
|
|
|
|
- [prind](https://github.com/mkuf/prind) by mkuf
|
|
- A suite of containers which allow you to run Klipper in
|
|
Docker. Includes support for OctoPrint and Moonraker.
|
|
|
|
### Changes
|
|
|
|
This section contains changelogs that users and developers may reference
|
|
to see if any action is necessary on their part. The date of the most
|
|
recent change is included.
|
|
|
|
Users:\
|
|
[user_changes.md](https://moonraker.readthedocs.io/en/latest/user_changes/) - Febuary 22nd 2022
|
|
|
|
Developers:\
|
|
[api_changes.md](https://moonraker.readthedocs.io/en/latest/api_changes/) - March 4th 2022
|