Klipper3d / klipper

Klipper is a 3d-printer firmware
GNU General Public License v3.0
9.34k stars 5.28k forks source link

Add manual installation instructions #6356

Closed Michal-Szczepaniak closed 11 months ago

Michal-Szczepaniak commented 1 year ago

I found that in personal experience, when you're not running on debian or debian-based distros you have very hard time getting any instructions for installing klipper and best for now are the installation scripts. So I took whats inside those scripts and compiled them into manual installation instruction for anyone like me that is not running debian-based distro or even raspberry pi for that matter. I will adjust if any changes will be necessary.

KevinOConnor commented 1 year ago

Thanks. Can you elaborate on the advantage of adding this document as opposed to pointing users to the script? I would think that users able to manually install would be able to understand the steps detailed in the basic installation script.

-Kevin

Michal-Szczepaniak commented 1 year ago

I was told that the scripts would be deleted in favour of https://github.com/dw-0/kiauh. Additionally it's quite nicer to have description rather to read script directly.

I myself would appreciate having clear guide than searching through code and reading script honestly it's always nice to have it documented

github-actions[bot] commented 11 months ago

Thank you for your contribution to Klipper. Unfortunately, a reviewer has not assigned themselves to this GitHub Pull Request. All Pull Requests are reviewed before merging, and a reviewer will need to volunteer. Further information is available at: https://www.klipper3d.org/CONTRIBUTING.html

There are some steps that you can take now:

  1. Perform a self-review of your Pull Request by following the steps at: https://www.klipper3d.org/CONTRIBUTING.html#what-to-expect-in-a-review If you have completed a self-review, be sure to state the results of that self-review explicitly in the Pull Request comments. A reviewer is more likely to participate if the bulk of a review has already been completed.
  2. Consider opening a topic on the Klipper Discourse server to discuss this work. The Discourse server is a good place to discuss development ideas and to engage users interested in testing. Reviewers are more likely to prioritize Pull Requests with an active community of users.
  3. Consider helping out reviewers by reviewing other Klipper Pull Requests. Taking the time to perform a careful and detailed review of others work is appreciated. Regular contributors are more likely to prioritize the contributions of other regular contributors.

Unfortunately, if a reviewer does not assign themselves to this GitHub Pull Request then it will be automatically closed. If this happens, then it is a good idea to move further discussion to the Klipper Discourse server. Reviewers can reach out on that forum to let you know if they are interested and when they are available.

Best regards, ~ Your friendly GitIssueBot

PS: I'm just an automated script, not a human being.

Michal-Szczepaniak commented 11 months ago

@KevinOConnor I really think this should be merged, there's nothing wrong with adding helpful instructions isn't it? I myself would prefer to have it nicely in documentation rather than searching code for installation scripts and then deciphering what has to be done. It would really have potential to help people out

Sineos commented 11 months ago

While your instructions seem to be correct, I'm not sure if they do bring more clarity to the users or rather the opposite.

Michal-Szczepaniak commented 11 months ago

@Sineos I disagree "Someone who is experienced in Linux will not really need them", then we can just as well remove the normal installation instructions as non-experienced people will also not need them they can just run script. It will take them both several more hours without instructions but they don't need them right? Even if you're experienced its much faster to have nicely documented instructions rather than spending hours trying to figure out what am i supposed to do. I don't even know why you're both opposed to making life easier for people

someone who's not as experienced can ask for help on discord or forums

github-actions[bot] commented 11 months ago

Unfortunately a reviewer has not assigned themselves to this GitHub Pull Request and it is therefore being closed. It is a good idea to move further discussion to the Klipper Discourse server. Reviewers can reach out on that forum to let you know if they are interested and when they are available.

Best regards, ~ Your friendly GitIssueBot

PS: I'm just an automated script, not a human being.

naikymen commented 10 months ago

I second Michal's view. I am an experienced Linux user, and I would have loved to follow these instructions instead of also investing time in reverse-engineering the dependencies.

This PR is helpful and should be merged! :)