docs: Avoid using .. in markdown links
Using .. in the markdown link can confuse some document processors. Use an absolute link to github instead. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
This commit is contained in:
parent
9cb21de68e
commit
8bc9f39c58
43
docs/FAQ.md
43
docs/FAQ.md
|
@ -99,12 +99,13 @@ and make sure FLASH_DEVICE is set correctly for your board (see the
|
|||
|
||||
However, if "make flash" just doesn't work for your board, then you
|
||||
will need to manually flash. See if there is a config file in the
|
||||
[config directory](../config) with specific instructions for flashing
|
||||
the device. Also, check the board manufacturer's documentation to see
|
||||
if it describes how to flash the device. Finally, on AVR devices, it
|
||||
may be possible to manually flash the device using
|
||||
[avrdude](http://www.nongnu.org/avrdude/) with custom command-line
|
||||
parameters - see the avrdude documentation for further information.
|
||||
[config directory](https://github.com/KevinOConnor/klipper/tree/master/config)
|
||||
with specific instructions for flashing the device. Also, check the
|
||||
board manufacturer's documentation to see if it describes how to flash
|
||||
the device. Finally, on AVR devices, it may be possible to manually
|
||||
flash the device using [avrdude](http://www.nongnu.org/avrdude/) with
|
||||
custom command-line parameters - see the avrdude documentation for
|
||||
further information.
|
||||
|
||||
### How do I change the serial baud rate?
|
||||
|
||||
|
@ -145,8 +146,8 @@ machines (the printer may move faster than OctoPrint can send movement
|
|||
commands) when printing directly from OctoPrint. If you wish to run on
|
||||
one one of these slower boards anyway, consider using the
|
||||
"virtual_sdcard" feature (see
|
||||
[config/example-extras.cfg](../config/example-extras.cfg) for details)
|
||||
when printing.
|
||||
[config/example-extras.cfg](https://github.com/KevinOConnor/klipper/tree/master/config/example-extras.cfg)
|
||||
for details) when printing.
|
||||
|
||||
For running on the Beaglebone, see the
|
||||
[Beaglebone specific installation instructions](beaglebone.md).
|
||||
|
@ -156,8 +157,8 @@ only requires Python running on a Linux (or similar)
|
|||
computer. However, if you wish to run it on a different machine you
|
||||
will need Linux admin knowledge to install the system prerequisites
|
||||
for that particular machine. See the
|
||||
[install-octopi.sh](../scripts/install-octopi.sh) script for further
|
||||
information on the necessary Linux admin steps.
|
||||
[install-octopi.sh](https://github.com/KevinOConnor/klipper/tree/master/scripts/install-octopi.sh)
|
||||
script for further information on the necessary Linux admin steps.
|
||||
|
||||
### Can I run multiple instances of Klipper on the same host machine?
|
||||
|
||||
|
@ -176,9 +177,10 @@ own pseudo-tty. For example:
|
|||
|
||||
If you choose to do this, you will need to implement the necessary
|
||||
start, stop, and installation scripts (if any). The
|
||||
[install-octopi.sh](../scripts/install-octopi.sh) script and the
|
||||
[klipper-start.sh](../scripts/klipper-start.sh) script may be useful
|
||||
as examples.
|
||||
[install-octopi.sh](https://github.com/KevinOConnor/klipper/tree/master/scripts/install-octopi.sh)
|
||||
script and the
|
||||
[klipper-start.sh](https://github.com/KevinOConnor/klipper/tree/master/scripts/klipper-start.sh)
|
||||
script may be useful as examples.
|
||||
|
||||
### Do I have to use OctoPrint?
|
||||
|
||||
|
@ -213,8 +215,8 @@ process itself (or fundamentally does not have a homing process) then
|
|||
consider using a homing_override section in the config file. If you
|
||||
need to move a stepper for diagnostic or debugging purposes then
|
||||
consider adding a force_move section to the config file. See
|
||||
[example-extras.cfg](../config/example-extras.cfg) for further details
|
||||
on these options.
|
||||
[example-extras.cfg](https://github.com/KevinOConnor/klipper/tree/master/config/example-extras.cfg)
|
||||
for further details on these options.
|
||||
|
||||
### Why is the Z position_endstop set to 0.5 in the default configs?
|
||||
|
||||
|
@ -371,15 +373,16 @@ See the "config_digital_out" command in the
|
|||
In addition, the micro-controller software is configured with a
|
||||
minimum and maximum temperature range for each heater at startup (see
|
||||
the min_temp and max_temp parameters in the
|
||||
[example.cfg](../config/example.cfg) file for details). If the
|
||||
micro-controller detects that the temperature is outside of that range
|
||||
then it will also enter a "shutdown" state.
|
||||
[example.cfg](https://github.com/KevinOConnor/klipper/tree/master/config/example.cfg)
|
||||
file for details). If the micro-controller detects that the
|
||||
temperature is outside of that range then it will also enter a
|
||||
"shutdown" state.
|
||||
|
||||
Separately, the host software also implements code to check that
|
||||
heaters and temperature sensors are functioning correctly. See the
|
||||
"verify_heater" section of the
|
||||
[example-extras.cfg](../config/example-extras.cfg) for further
|
||||
details.
|
||||
[example-extras.cfg](https://github.com/KevinOConnor/klipper/tree/master/config/example-extras.cfg)
|
||||
for further details.
|
||||
|
||||
### How do I convert a Marlin pin number to a Klipper pin name?
|
||||
|
||||
|
|
|
@ -116,7 +116,9 @@ Klipper supports many standard 3d printer features:
|
|||
document for more information.
|
||||
|
||||
* Sample configuration files are available for many common printers.
|
||||
Check the [config directory](../config/) for a list.
|
||||
Check the
|
||||
[config directory](https://github.com/KevinOConnor/klipper/tree/master/config/)
|
||||
for a list.
|
||||
|
||||
To get started with Klipper, read the [installation](Installation.md)
|
||||
guide.
|
||||
|
|
|
@ -42,9 +42,9 @@ possible G-Code command. Instead, Klipper prefers human readable
|
|||
|
||||
If one requires a less common G-Code command then it may be possible
|
||||
to implement it with a custom Klipper gcode_macro (see
|
||||
[example-extras.cfg](../config/example-extras.cfg) for details). For
|
||||
example, one might use this to implement: `G10`, `G11`, `G12`, `G29`,
|
||||
`G30`, `G31`, `M42`, `M80`, `M81`, etc.
|
||||
[example-extras.cfg](https://github.com/KevinOConnor/klipper/tree/master/config/example-extras.cfg)
|
||||
for details). For example, one might use this to implement: `G10`,
|
||||
`G11`, `G12`, `G29`, `G30`, `G31`, `M42`, `M80`, `M81`, etc.
|
||||
|
||||
## G-Code SD card commands
|
||||
|
||||
|
|
|
@ -127,11 +127,11 @@ 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](../config/). The
|
||||
[example.cfg](../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 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.
|
||||
|
||||
Arguably the easiest way to update the Klipper configuration file is
|
||||
to use a desktop editor that supports editing files over the "scp"
|
||||
|
|
|
@ -9,10 +9,12 @@ chips. Read [features](Features.md) for reasons to use Klipper. See
|
|||
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
|
||||
as a reference for the config file. See the [Slicers](Slicers.md)
|
||||
document for information on configuring a slicer with Klipper. See the
|
||||
[Bed Level](Bed_Level.md), [Endstop Phase](Endstop_Phase.md),
|
||||
machine. The
|
||||
[config/example.cfg](https://github.com/KevinOConnor/klipper/tree/master/config/example.cfg)
|
||||
file serves as a reference for the config file. See the
|
||||
[Slicers](Slicers.md) document for information on configuring a slicer
|
||||
with Klipper. See the [Bed Level](Bed_Level.md),
|
||||
[Endstop Phase](Endstop_Phase.md),
|
||||
[Probe Calibrate](Probe_Calibrate.md),
|
||||
[Delta Calibrate](Delta_Calibrate.md), and
|
||||
[Manual Level](Manual_Level.md) documents for information on bed
|
||||
|
|
|
@ -18,8 +18,9 @@ END_PRINT in the slicer's configuration. Defining these actions in the
|
|||
Klipper configuration may make it easier to tweak the printer's start
|
||||
and end steps as changes do not require re-slicing.
|
||||
|
||||
See the [example-extras.cfg](../config/example-extras.cfg) file for
|
||||
details on defining a gcode_macro.
|
||||
See the
|
||||
[example-extras.cfg](https://github.com/KevinOConnor/klipper/tree/master/config/example-extras.cfg)
|
||||
file for details on defining a gcode_macro.
|
||||
|
||||
# Large retraction settings may require tuning Klipper
|
||||
|
||||
|
|
|
@ -99,5 +99,6 @@ Unfortunately, the Beaglebone processor can sometimes struggle to run
|
|||
OctoPrint well. Print stalls have been known to occur on complex
|
||||
prints (the printer may move faster than OctoPrint can send movement
|
||||
commands). If this occurs, consider using the "virtual_sdcard" feature
|
||||
(see [config/example-extras.cfg](../config/example-extras.cfg) for
|
||||
details) to print directly from Klipper.
|
||||
(see
|
||||
[config/example-extras.cfg](https://github.com/KevinOConnor/klipper/tree/master/config/example-extras.cfg)
|
||||
for details) to print directly from Klipper.
|
||||
|
|
Loading…
Reference in New Issue