diff --git a/docs/FAQ.md b/docs/FAQ.md new file mode 100644 index 00000000..b59430a4 --- /dev/null +++ b/docs/FAQ.md @@ -0,0 +1,33 @@ +# Frequently Asked Questions + +## What is the minimum Python version required? + +The minimum version is Python 3.7, this is checked during install. + +## OctoPrint? + +KlipperScreen was not designed to work with OctoPrint and there are no plans to make it compatible. + +## How to Check if You Have a Desktop Environment +1. Let you device finish startup +2. At the end of the boot process look at the screen and check using this examples + + +| Desktop environment | Console | +|:------------------------------------------:|:--------------------------------------------:| +| ![de](../img/troubleshooting/desktop.png) | ![boot](../img/troubleshooting/boot.png) | +| Desktop environment | Console | +| ![delog](../img/troubleshooting/delog.png) | ![clilog](../img/troubleshooting/clilog.png) | + +## Can i use KlipperScreen as a desktop application? + +Yes, First disable the service: + +```shell +sudo systemctl disable KlipperScreen +``` + +and open the application via the menu when you need it. + + +you can also find the shortcut in `KlipperScreen/scripts/KlipperScreen.desktop` \ No newline at end of file diff --git a/docs/Troubleshooting.md b/docs/Troubleshooting.md index 8f576c78..dfacdece 100644 --- a/docs/Troubleshooting.md +++ b/docs/Troubleshooting.md @@ -123,17 +123,12 @@ If you find a way of turning it off and you want to share it: [Contact](Contact. ## Touch issues - [Follow this steps](Troubleshooting/Touch_issues.md) ## Network panel doesn't list WI-FI networks [Follow this steps](Troubleshooting/Network.md) -## OctoPrint - -KlipperScreen was never intended to be used with OctoPrint, and there is no support for it. - ## Other issues If you found an issue not listed here, or can't make it work, please provide all the log files diff --git a/docs/img/troubleshooting/boot.png b/docs/img/troubleshooting/boot.png index 337499eb..8b581cb8 100644 Binary files a/docs/img/troubleshooting/boot.png and b/docs/img/troubleshooting/boot.png differ diff --git a/docs/img/troubleshooting/clilog.png b/docs/img/troubleshooting/clilog.png new file mode 100644 index 00000000..a838042c Binary files /dev/null and b/docs/img/troubleshooting/clilog.png differ diff --git a/docs/img/troubleshooting/delog.png b/docs/img/troubleshooting/delog.png new file mode 100644 index 00000000..a8b698ac Binary files /dev/null and b/docs/img/troubleshooting/delog.png differ diff --git a/docs/img/troubleshooting/desktop.png b/docs/img/troubleshooting/desktop.png new file mode 100644 index 00000000..d43f7824 Binary files /dev/null and b/docs/img/troubleshooting/desktop.png differ diff --git a/mkdocs.yml b/mkdocs.yml index 9ea16075..fdf5ba88 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -7,6 +7,7 @@ repo_name: KlipperScreen/KlipperScreen/ repo_url: https://github.com/KlipperScreen/KlipperScreen/ nav: - Home: index.md + - FAQ: FAQ.md - Setup: - Hardware.md - Installation.md