diff options
| author | Damien <damlobster@gmail.com> | 2021-07-22 00:40:40 +0200 |
|---|---|---|
| committer | KevinOConnor <kevin@koconnor.net> | 2021-07-27 13:15:25 -0400 |
| commit | cff61605fb7260ab60d1abd4e295b71a533869ac (patch) | |
| tree | f117dd64e85ec18a62c7c4305781fa03d37ed0a9 /docs/Installation.md | |
| parent | 7e88f9220c641dd1e7e5b748381bd7ac758bc8d2 (diff) | |
| download | kutter-cff61605fb7260ab60d1abd4e295b71a533869ac.tar.gz kutter-cff61605fb7260ab60d1abd4e295b71a533869ac.tar.xz kutter-cff61605fb7260ab60d1abd4e295b71a533869ac.zip | |
docs : make modifications to all md files to make them compatible with mkdocs
all markdown files must have a single H1 heading at the top.
Signed-off-by: Damien Martin <damlobster@gmail.com>
Update CNAME
Diffstat (limited to 'docs/Installation.md')
| -rw-r--r-- | docs/Installation.md | 17 |
1 files changed, 7 insertions, 10 deletions
diff --git a/docs/Installation.md b/docs/Installation.md index b04bef80..faf4d71c 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -1,3 +1,5 @@ +# Installation + These instructions assume the software will run on a Raspberry Pi computer in conjunction with OctoPrint. It is recommended that a Raspberry Pi 2, 3, or 4 computer be used as the host machine (see the @@ -9,8 +11,7 @@ micro-controllers, [ARM based micro-controllers](Features.md#step-benchmarks), and [Beaglebone PRU](beaglebone.md) based printers. -Prepping an OS image -==================== +## Prepping an OS image Start by installing [OctoPi](https://github.com/guysoft/OctoPi) on the Raspberry Pi computer. Use OctoPi v0.17.0 or later - see the @@ -38,8 +39,7 @@ setup Klipper to run at system startup, and start the Klipper host software. It will require an internet connection and it may take a few minutes to complete. -Building and flashing the micro-controller -========================================== +## Building and flashing the micro-controller To compile the micro-controller code, start by running these commands on the Raspberry Pi: @@ -92,8 +92,7 @@ When flashing for the first time, make sure that OctoPrint is not connected directly to the printer (from the OctoPrint web page, under the "Connection" section, click "Disconnect"). -Configuring OctoPrint to use Klipper -==================================== +## Configuring OctoPrint to use Klipper The OctoPrint web server needs to be configured to communicate with the Klipper host software. Using a web browser, login to the OctoPrint @@ -121,8 +120,7 @@ terminal window will likely report there is an error opening the config file - that means OctoPrint is successfully communicating with Klipper. Proceed to the next section. -Configuring Klipper -=================== +## 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 @@ -182,8 +180,7 @@ After Klipper reports that the printer is ready go on to the [config check document](Config_checks.md) to perform some basic checks on the pin definitions in the config file. -Contacting the developers -========================= +## Contacting the developers Be sure to see the [FAQ](FAQ.md) for answers to some common questions. See the [contact page](Contact.md) to report a bug or to contact the |