CreatBot/CreatBotKlipper
CreatBot/CreatBotKlipper
7
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Fix typos in installation.md

Browse Source 
Fixed typos, hyphenation, and minor phrasing for better readability.

Signed-off-by: Tobias Rumiz <TobiasRumiz@gmail.com>
This commit is contained in:
Tobias Rumiz 2025-03-29 01:36:26 -03:00 committed by KevinOConnor
parent 52617455ce
commit f511e201f9
1 changed files with 21 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
docs/Installation.md
View File

@ -1,14 +1,14 @@
# Installation # Installation
These instructions assume the software will run on a linux based host These instructions assume the software will run on a Linux-based host
running a Klipper compatible front end. It is recommended that a running a Klipper-compatible front end. It is recommended that a
SBC(Small Board Computer) such as a Raspberry Pi or Debian based Linux SBC(Small Board Computer) such as a Raspberry Pi or Debian-based Linux
device be used as the host machine (see the device be used as the host machine (see the
[FAQ](FAQ.md#can-i-run-klipper-on-something-other-than-a-raspberry-pi-3) [FAQ](FAQ.md#can-i-run-klipper-on-something-other-than-a-raspberry-pi-3)
for other options). for other options).
For the purposes of these instructions host relates to the Linux device and For the purposes of these instructions, host relates to the Linux device and
mcu relates to the printboard. SBC relates to the term Small Board Computer mcu relates to the printer board. SBC relates to the term Small Board Computer
such as the Raspberry Pi. such as the Raspberry Pi.
## Obtain a Klipper Configuration File ## Obtain a Klipper Configuration File
@ -56,13 +56,13 @@ make an informed decision.
## Obtaining an OS image for SBC's ## Obtaining an OS image for SBC's
There are many ways to obtain an OS image for Klipper for SBC use, most depend on There are many ways to obtain an OS image for Klipper for SBC use, most depend on
what front end you wish to use. Some manafactures of these SBC boards also provide what front end you wish to use. Some manufacturers of these SBC boards also provide
their own Klipper-centric images. their own Klipper-centric images.
The two main Moonraker based front ends are [Fluidd](https://docs.fluidd.xyz/) The two main Moonraker-based front ends are [Fluidd](https://docs.fluidd.xyz/)
and [Mainsail](https://docs.mainsail.xyz/), the latter of which has a premade install and [Mainsail](https://docs.mainsail.xyz/), the latter of which has a premade install
image ["MainsailOS"](https://docs-os.mainsail.xyz/), this has the option for Raspberry Pi image ["MainsailOS"](https://docs-os.mainsail.xyz/), this has the option for Raspberry Pi
and some OrangePi varianta. and some OrangePi variants.
Fluidd can be installed via KIAUH(Klipper Install And Update Helper), which Fluidd can be installed via KIAUH(Klipper Install And Update Helper), which
is explained below and is a 3rd party installer for all things Klipper. is explained below and is a 3rd party installer for all things Klipper.
@ -73,12 +73,12 @@ process is explained in [OctoPrint.md](OctoPrint.md)
## Installing via KIAUH ## Installing via KIAUH
Normally you would start with a base image for your SBC, RPiOS Lite for example, Normally you would start with a base image for your SBC, RPiOS Lite for example,
or in the case of a x86 Linux device, Ubuntu Server. Please note that Desktop or in the case of an x86 Linux device, Ubuntu Server. Please note that Desktop
variants are not recommended due to certain helper programs that can stop some variants are not recommended due to certain helper programs that can stop some
Klipper functions working and even mask access to some print boards. Klipper functions from working and even mask access to some printer boards.
KIAUH can be used to install Klipper and its associated programs on a variety KIAUH can be used to install Klipper and its associated programs on a variety
of Linux based systems that run a form of Debian. More information can be found of Linux-based systems that run a form of Debian. More information can be found
at https://github.com/dw-0/kiauh at https://github.com/dw-0/kiauh
## Building and flashing the micro-controller ## Building and flashing the micro-controller
@ -106,7 +106,7 @@ make
If the comments at the top of the If the comments at the top of the
[printer configuration file](#obtain-a-klipper-configuration-file) [printer configuration file](#obtain-a-klipper-configuration-file)
describe custom steps for "flashing" the final image to the printer describe custom steps for "flashing" the final image to the printer
control board then follow those steps and then proceed to control board, then follow those steps and then proceed to
[configuring OctoPrint](#configuring-octoprint-to-use-klipper). [configuring OctoPrint](#configuring-octoprint-to-use-klipper).
Otherwise, the following steps are often used to "flash" the printer Otherwise, the following steps are often used to "flash" the printer
@ -132,12 +132,12 @@ run the command again, the missing item will be your print board(see the
[FAQ](FAQ.md#wheres-my-serial-port) for more information). [FAQ](FAQ.md#wheres-my-serial-port) for more information).
For common micro-controllers with STM32 or clone chips, LPC chips and For common micro-controllers with STM32 or clone chips, LPC chips and
others it is usual that these need an initial Klipper flash via SD card. others, it is usual that these need an initial Klipper flash via SD card.
When flashing with this method, it is important to make sure that the When flashing with this method, it is important to make sure that the
print board is not connected with USB to the host, due to some boards print board is not connected with USB to the host, due to some boards
being able to feed power back to the board and stopping a flash from being able to feed power back to the board and stopping a flash from
occuring. occurring.
For common micro-controllers using Atmega chips, for example the 2560, For common micro-controllers using Atmega chips, for example the 2560,
the code can be flashed with something the code can be flashed with something
@ -172,7 +172,7 @@ The next step is to copy the
the host. the host.
Arguably the easiest way to set the Klipper configuration file is using the Arguably the easiest way to set the Klipper configuration file is using the
built in editors in Mainsail or Fluidd. These will allow the user to open built-in editors in Mainsail or Fluidd. These will allow the user to open
the configuration examples and save them to be printer.cfg. the configuration examples and save them to be printer.cfg.
Another option is to use a desktop editor that supports editing files Another option is to use a desktop editor that supports editing files
@ -183,7 +183,7 @@ named "printer.cfg" in the home directory of the pi user
(ie, /home/pi/printer.cfg). (ie, /home/pi/printer.cfg).
Alternatively, one can also copy and edit the file directly on the Alternatively, one can also copy and edit the file directly on the
host via ssh. That may look something like the following (be host via SSH. That may look something like the following (be
sure to update the command to use the appropriate printer config sure to update the command to use the appropriate printer config
filename): filename):
@ -214,9 +214,9 @@ the `[mcu]` section to look something similar to:
serial: /dev/serial/by-id/usb-1a86_USB2.0-Serial-if00-port0 serial: /dev/serial/by-id/usb-1a86_USB2.0-Serial-if00-port0
``` ```
After creating and editing the file it will be necessary to issue a After creating and editing the file, it will be necessary to issue a
"restart" command in the command console to load the config. A "restart" command in the command console to load the config. A
"status" command will report the printer is ready if the Klipper "status" command will report that the printer is ready if the Klipper
config file is successfully read and the micro-controller is config file is successfully read and the micro-controller is
successfully found and configured. successfully found and configured.
@ -225,10 +225,10 @@ Klipper to report a configuration error. If an error occurs, make any
necessary corrections to the printer config file and issue "restart" necessary corrections to the printer config file and issue "restart"
until "status" reports the printer is ready. until "status" reports the printer is ready.
Klipper reports error messages via the command console and via pop up in Klipper reports error messages via the command console and pop-ups in
Fluidd and Mainsail. The "status" command can be used to re-report error Fluidd and Mainsail. The "status" command can be used to re-report error
messages. A log is available and usually located in ~/printer_data/logs messages. A log is available and usually located at
this is named klippy.log `~/printer_data/logs/klippy.log`.
After Klipper reports that the printer is ready, proceed to the After Klipper reports that the printer is ready, proceed to the
[config check document](Config_checks.md) to perform some basic checks [config check document](Config_checks.md) to perform some basic checks