klipper icon indicating copy to clipboard operation
klipper copied to clipboard

Improve developer documentation

Open shitwolfymakes opened this issue 11 months ago • 3 comments

I noticed there's 0 explanation of how to compile klipper without installing it to the host system, so I added a section to the developer docs to explain how.

I don't like that it involves single-use modification of the build scripts, but that seems like the only real way to do this aside from adding scripts just to install dependencies for every OS with an installer

shitwolfymakes avatar Jan 24 '25 16:01 shitwolfymakes

All PR's need signing off as mentioned in point 3 in https://github.com/Klipper3d/klipper/blob/master/docs/CONTRIBUTING.md#what-to-expect-in-a-review

Thanks James

JamesH1978 avatar Jan 25 '25 11:01 JamesH1978

I would think a simple list of the software needed to compile firmware would be enough, then those developers wanting to only build firmware and not fully install klipper and its env, would be able to extrapolate the actual packages needed for their particular flavor of linux. For example, developer's libraries for ncurses, Arm GNU Toolchain, GCC, etc or even just the list of debian packages as klipper is usually installed on those flavors.

Thanks James

JamesH1978 avatar Jan 25 '25 11:01 JamesH1978

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.

github-actions[bot] avatar Feb 10 '25 00:02 github-actions[bot]