CreatBot/CreatBotMoonraker
7
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
CreatBotMoonraker/docs/index.md
Brian 'Redbeard' Harrington be2e8623b9 docs: Remove ambiguity from documentation index 
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>
2022-03-29 15:20:41 -04:00

918 B
Raw Blame History

Welcome to Moonraker Documentation

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. Communcation between the Klippy host and Moonraker is done over a Unix Domain Socket. Tornado is used to provide Moonraker's server functionality.

Users should refer to the Installation and Configuration sections for documentation on how to install and configure Moonraker.

Client developers may refer to the Client API documentation.

Backend developers should refer to the contibuting section for basic contribution guidelines prior to creating a pull request. The components document provides a brief overview of how to create a component and interact with Moonraker's primary internal APIs.