Improve developer documentation #6792
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
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 |
|
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 |
Signed-off-by: Andrew Sneed <[email protected]>
shitwolfymakes
force-pushed
the
pr-improve-dev-docs
branch
from
61cf78d to
53c7b56
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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