diff options
author | Kevin O'Connor <kevin@koconnor.net> | 2017-12-26 20:16:53 -0500 |
---|---|---|
committer | Kevin O'Connor <kevin@koconnor.net> | 2017-12-26 20:54:37 -0500 |
commit | 1bdebeaebf0e5e487f4210f8d5d745150572d8cd (patch) | |
tree | 15e7e135e3f83579e560f141f67d5c366ab5998c /docs/Overview.md | |
parent | 479772ca00d2e0c37d13fea889db1ae57c223a66 (diff) | |
download | kutter-1bdebeaebf0e5e487f4210f8d5d745150572d8cd.tar.gz kutter-1bdebeaebf0e5e487f4210f8d5d745150572d8cd.tar.xz kutter-1bdebeaebf0e5e487f4210f8d5d745150572d8cd.zip |
docs: Add an initial configuration checklist document
Provide a document with basic steps that a user can run to verify that
the pins in the configuration file are set correctly.
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs/Overview.md')
-rw-r--r-- | docs/Overview.md | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/docs/Overview.md b/docs/Overview.md index 31ba04b9..9358bc27 100644 --- a/docs/Overview.md +++ b/docs/Overview.md @@ -4,7 +4,9 @@ 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 -[installation](Installation.md) to get started with Klipper. +[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. The Klipper configuration is stored in a simple text file on the host machine. The [config/example.cfg](../config/example.cfg) file serves @@ -26,7 +28,8 @@ 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 -on the structure and layout of the Klipper code. +on the structure and layout of the Klipper code. See the +[contributing](CONTRIBUTING.md) document to submit improvements to Klipper. See [protocol](Protocol.md) for information on the low-level messaging protocol between host and micro-controller. See also |