aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Installation.md
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2020-11-16 18:47:32 -0500
committerKevin O'Connor <kevin@koconnor.net>2020-11-18 20:10:21 -0500
commit15b5dbaf8ffac8e3889b2cc0ba7a61bce1e9fb6f (patch)
treefbb9fb7be4266684eb67f0b7d36379b523f8a240 /docs/Installation.md
parent9fd8f7761e424807c9f69165430e562bb2ab0390 (diff)
downloadkutter-15b5dbaf8ffac8e3889b2cc0ba7a61bce1e9fb6f.tar.gz
kutter-15b5dbaf8ffac8e3889b2cc0ba7a61bce1e9fb6f.tar.xz
kutter-15b5dbaf8ffac8e3889b2cc0ba7a61bce1e9fb6f.zip
docs: Move config reference information to new Config_Reference.md
Move all the config reference information from files in the config/ directory to a new Config_Reference.md document. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs/Installation.md')
-rw-r--r--docs/Installation.md8
1 files changed, 3 insertions, 5 deletions
diff --git a/docs/Installation.md b/docs/Installation.md
index 50fc3c78..049690b4 100644
--- a/docs/Installation.md
+++ b/docs/Installation.md
@@ -127,10 +127,8 @@ Configuring Klipper
The Klipper configuration is stored in a text file on the Raspberry
Pi. Take a look at the example config files in the
[config directory](https://github.com/KevinOConnor/klipper/tree/master/config/). The
-[example.cfg](https://github.com/KevinOConnor/klipper/tree/master/config/example.cfg)
-file contains documentation on command parameters and it can also be
-used as an initial config file template. However, for most printers,
-one of the other config files may be a more concise starting point.
+[config reference](Config_Reference.md) contains documentation on
+config parameters.
Arguably the easiest way to update the Klipper configuration file is
to use a desktop editor that supports editing files over the "scp"
@@ -144,7 +142,7 @@ Alternatively, one can also copy and edit the file directly on the
Raspberry Pi via ssh - for example:
```
-cp ~/klipper/config/example.cfg ~/printer.cfg
+cp ~/klipper/config/example-cartesian.cfg ~/printer.cfg
nano ~/printer.cfg
```