dw-0 / kiauh

Klipper Installation And Update Helper
GNU General Public License v3.0
3.4k stars 492 forks source link

README.md should contain minimum configuration steps #205

Closed 5ilver closed 2 years ago

5ilver commented 2 years ago

Is your feature request related to a problem? Please describe

After running the kiauh script the user is left at a documentation dead end. Seeking examples on reddit or youtube is required to proceed.

Describe the solution you'd like

The readme should contain the minimum set of applications to install and instructions on how to access them. It should also include how one should configure klipper and a microcontroller.

Documentation for this could be links to other documentation in a "next steps" section.

Describe alternatives you've considered

No response

Additional information

No response

dw-0 commented 2 years ago

After running the kiauh script the user is left at a documentation dead end. Seeking examples on reddit or youtube is required to proceed.

Can you elaborate on that please? I am not quite sure for what exact reason reddit or youtube is required for the overall usage of KIAUH. Are the menus not descriptive enough? Are some things worded too difficult to understand? Im always open for improving descriptions or wordings to make them easier and better to understand.

The readme should contain the minimum set of applications to install and instructions on how to access them.

There is no minimum set of applications. But if we pretend there is, just to give justification to the existence of KIAUH, then the absolute minimum application to install is Klipper obviously. But that is imho something not worth mentioning in the readme, as i expect every user who is downloading and using KIAUH has already a clear intention what KIAUH should accomplish or what it should help with. Although i agree, that i could add a short overview of the applications KIAUH can install again.

It should also include how one should configure klipper and a microcontroller.

I disagree with that as i do not see this as part of KIAUHs scope. I also expect every user to inform himself/herself before even starting with Klipper and therefore the consideration of using KIAUH to install it.