From 13b2fe51ff7c928a64555367617be010917941aa Mon Sep 17 00:00:00 2001 From: alfrix Date: Fri, 5 Apr 2024 23:08:12 -0300 Subject: [PATCH] docs: minor changes --- .github/ISSUE_TEMPLATE/bug_report.yml | 4 +--- docs/Quicktips.md | 12 +++++++++++- docs/VNC.md | 14 ++++++++------ 3 files changed, 20 insertions(+), 10 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 42b784fb..786208e6 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -12,7 +12,7 @@ body: This is a bug report, If you need general support, please visit us on [Discord](https://discord.klipper3d.org/) # Guidelines: - 1. Logfile must be provided and not just a little snip, from ks startup up to the bug + 1. Logfile must be provided from ks startup up to the bug 2. The version used must be from this repo (not a fork) 3. The version used shouldn't be too old (older than the last tagged version) @@ -66,7 +66,5 @@ body: #### The LOG file is REQUIRED. Without the logfile your issue will be closed Use a Zip archive if needed - - render: shell validations: required: true diff --git a/docs/Quicktips.md b/docs/Quicktips.md index 31786685..5709685b 100644 --- a/docs/Quicktips.md +++ b/docs/Quicktips.md @@ -4,7 +4,9 @@ quick tips, without much explanation ## Hide macros, outputs or fans -You can also hide devices by prefixing the name with an underscore. +Macros can be hidden directly from the interface in the macro settings. + +You can also hide them and other devices by prefixing the name with an underscore. Lets hide a temperature_fan: @@ -20,6 +22,10 @@ fan1 will show in the interface, but _fan2 will be hidden. ### Accurate layer progress as a message below the status: +* [PrusaSlicer](#prusaslicer) +* [Cura](#cura) +* [ideaMaker](#ideamaker) + #### PrusaSlicer * Open PrusaSlicer @@ -50,6 +56,10 @@ M117 Layer {layer_index} / {total_layers} ### Accurate layer progress in the secondary screen of the printing panel: +* [PrusaSlicer](#prusaslicer_1) +* [Cura](#cura_1) +* [ideaMaker](#ideamaker_1) + The layer number in the secondary screen of the printing panelis calculated according to object height and provided layer height. It will be innacurate when using variable layer height, but can be fixed by providing klipper with the correct data. diff --git a/docs/VNC.md b/docs/VNC.md index cb51e66d..e093b7c2 100644 --- a/docs/VNC.md +++ b/docs/VNC.md @@ -6,8 +6,9 @@ This article describes how to use KlipperScreen through a remote connection. The experience may not be equal to run KlipperScreen natively. Depending on the device or the network you may encounter performance degradation or other issues. -## On the Host device (for example a Raspberry Pi): +## On the Host device: +The host device could be for example a Raspberry Pi 1. [First install KlipperScreen](Installation.md) 2. Install a vnc server package, for example: @@ -31,7 +32,7 @@ This article describes how to use KlipperScreen through a remote connection. ```bash chmod +x ~/KlipperScreen/scripts/launch_KlipperScreen.sh ``` - + 5. Restart KlipperScreen or reboot the system: ```bash sudo systemctl restart KlipperScreen.service @@ -45,21 +46,22 @@ Turn off DPMS and Display timeout: ## On the remote device: -1. Installa a VNC viewer and configure it to the ip of the host. +1. Install a VNC viewer and configure it to the ip of the host. ???+ example "Example using an iPad" + #### Example using an iPad * Install a VNC viewer for example: `RealVNC Viewer: Remote Desktop` - #### Prevent unwanted rotation of UI: + ##### Prevent unwanted rotation of UI: * Go to `Settings` > `General` > Set `Use side switch to` to `Lock Rotation` - #### Avoid accidentally switching between apps: + ##### Avoid accidentally switching between apps: * Go to `Restrictions` > Set passcode > Enable restrictions. * Open * Triple-click "Home" button * Guided access pops up * Press "Start" * Now iPad is locked to VNC viewer until "Guided access" mode is disabled by triple-clicking "Home" button and entering the restrictions password. - #### On the VNC viewer: + ##### On the VNC viewer: * Press "+" button at the top right * Enter IP address of your print host. * Press "Save"