From bf70157a640de3b7a3477a6bd7f62050cc79284c Mon Sep 17 00:00:00 2001 From: th33xitus <31533186+th33xitus@users.noreply.github.com> Date: Mon, 13 Jul 2020 17:15:09 +0200 Subject: [PATCH] Update README.md --- README.md | 35 +++++++++++++++++++++++++++++++++-- 1 file changed, 33 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b0a76b8..d162a59 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +# THIS VERSION IS WORK IN PROGRESS!!! + # KIAUH ## Klipper Installation And Update Helper @@ -8,5 +10,34 @@ There are also functions for updating your current installations or removing the ## First things first: When you decide to use this script, you use it at your own risk! -# THIS VERSION IS WORK IN PROGRESS!!! -# BUGS MAY BE STILL PRESENT!!! +Give it a try if you want and if you have suggestions or encounter any problems, please report them. But i can't guarantee that i will fix them immediately (or at all). + +## Instructions: + +In order to run this script you have to make it executable. Use the following commands in the given order to download and execute the script. + +``` +cd ~ +git clone https://github.com/th33xitus/kiauh.git +chmod +x ~/kiauh/kiauh.sh +chmod +x ~/kiauh/scripts/* +./kiauh/kiauh.sh +``` + +## Restrictions: +* Tested only on Raspbian Buster Lite + +## Functions and Features: +Soon™ + + +## Q&A + +__*Q: Can i install octoprint with this script?*__ + +**A:** Soon™ + + +__*Q: Can i use this script to install multiple instancec of Klipper on the same Pi? (Multisession?)*__ + + **A:** No, and at the moment i don't plan to implement this function. For multisession installations take a look at this script manu7irl created: https://github.com/manu7irl/klipper-DWC2-installer