2017-04-27 21:31:48 +02:00
|
|
|
Welcome to the Klipper documentation. There are two parts to Klipper -
|
|
|
|
|
code that runs on a micro-controller and code that runs on a "host"
|
|
|
|
|
machine. The host code is intended to run on a low-cost
|
|
|
|
|
general-purpose machine such as a Raspberry Pi, while the
|
|
|
|
|
micro-controller code is intended to run on commodity micro-controller
|
|
|
|
|
chips. Read [features](Features.md) for reasons to use Klipper. See
|
2017-12-27 02:16:53 +01:00
|
|
|
[installation](Installation.md) to get started with Klipper. See
|
|
|
|
|
[config checks](Config_checks.md) for a guide to verify basic pin
|
|
|
|
|
settings in the config file.
|
2017-04-19 21:24:57 +02:00
|
|
|
|
2017-04-27 21:31:48 +02:00
|
|
|
The Klipper configuration is stored in a simple text file on the host
|
|
|
|
|
machine. The [config/example.cfg](../config/example.cfg) file serves
|
|
|
|
|
as a reference for the config file. The
|
|
|
|
|
[Pressure Advance](Pressure_Advance.md) document contains information
|
|
|
|
|
on tuning the pressure advance config.
|
2016-05-25 17:37:40 +02:00
|
|
|
|
2017-04-27 21:31:48 +02:00
|
|
|
The [kinematics](Kinematics.md) document provides some technical
|
2017-11-30 21:00:00 +01:00
|
|
|
details on how Klipper implements motion. The [FAQ](FAQ.md) answers
|
2018-03-08 20:06:24 +01:00
|
|
|
some common questions. The [G-Codes](G-Codes.md) document lists
|
|
|
|
|
currently supported run-time commands.
|
2017-04-27 21:31:48 +02:00
|
|
|
|
|
|
|
|
The history of Klipper releases is available at
|
2017-10-10 18:39:06 +02:00
|
|
|
[releases](Releases.md). See [contact](Contact.md) for information on
|
|
|
|
|
bug reporting and general communication with the developers.
|
2016-05-25 17:37:40 +02:00
|
|
|
|
2017-04-27 21:31:48 +02:00
|
|
|
Developer Documentation
|
|
|
|
|
=======================
|
|
|
|
|
|
|
|
|
|
There are also several documents available for developers interested
|
|
|
|
|
in understanding how Klipper works. Start with the
|
|
|
|
|
[code overview](Code_Overview.md) document - it provides information
|
2017-12-27 02:16:53 +01:00
|
|
|
on the structure and layout of the Klipper code. See the
|
|
|
|
|
[contributing](CONTRIBUTING.md) document to submit improvements to Klipper.
|
2016-12-24 00:28:09 +01:00
|
|
|
|
2017-04-27 21:31:48 +02:00
|
|
|
See [protocol](Protocol.md) for information on the low-level messaging
|
|
|
|
|
protocol between host and micro-controller. See also
|
2017-04-27 21:14:11 +02:00
|
|
|
[MCU commands](MCU_Commands.md) for a description of low-level
|
|
|
|
|
commands implemented in the micro-controller software.
|
2016-10-15 07:03:56 +02:00
|
|
|
|
2016-12-24 00:28:09 +01:00
|
|
|
See [debugging](Debugging.md) for information on how to test and debug
|
|
|
|
|
Klipper.
|
2016-10-12 15:34:41 +02:00
|
|
|
|
|
|
|
|
See [todo](Todo.md) for information on possible future code features.
|
