Repository navigation
docs: update Krux Installer usage for v0.0.24 #970
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
BLVCK-MAMBA-6
wants to merge
4
commits into
selfcustody:develop
Choose a base branch
from
BLVCK-MAMBA-6:docs/update-installer-usage
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+55
−216
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
d251b29
docs: update Krux Installer usage for v0.0.24
BLVCK-MAMBA-6 75cc0ca
docs: address Krux Installer usage review feedback
BLVCK-MAMBA-6 2c77e13
docs: improve installer settings screenshot readability
BLVCK-MAMBA-6 b517d66
docs: refine installer settings screenshot and guidance
BLVCK-MAMBA-6 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/root/.local/krux-installerisn´t a good place to give as example. Prefer another image with a proper example name.Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Now I'm reading
/home/user/krux-installer. But IIRC the path is is similar to$HOME/.local/krux-installer(need peer verification from others too). Also the image appear to be very small to me (i put some zoom to read it), is good to read on your video guys?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the clarification, @qlrd
I'll increase the displayed image width to improve readability.
Regarding the path, would /home/user/.local/krux-installer be an appropriate example based on the default $HOME/.local/krux-installer location? I'm currently testing on Windows, so I can't independently verify the Linux default.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
let's wait, i really not remember the correct path on unix-like cc @joaozinhom
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Confirmed: the default is $HOME/.local/krux-installer on both Linux and macOS (Windows: %LOCALAPPDATA%\krux-installer\local). So the /home/user/krux-installer in the screenshot is not the default; a retaken screenshot showing /home/user/.local/krux-installer would match a fresh install.
One thing worth noting about this setting: I checked the code and the "Asset's destination path" entry is a leftover from the download era. Since v0.0.22 the installer bundles the firmware and downloads nothing; the bundled .kfpkg files are unpacked by PyInstaller into its own temp directory and by KTool into a temporary directory at flash time, and nothing reads the destdir.assets config anymore. So the "Destination path of downloaded assets" description in Settings doesn't match any current behavior. I'd suggest not documenting it as a download path; maybe just drop that sentence and keep baudrate and locale.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@BLVCK-MAMBA-6 please update with a compliant image and instructions above
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, I just updated the Settings screenshot with the correct Windows default destination path.
I also dropped the old asset destination explanation, since the current installer doesn’t use that setting. Only Flash baudrate and Locale are left.
I only have Windows, so a Linux screenshot will have to be a separate follow-up.
Thank you guys @joaozinhom @qlrd