Simplify, update, detail keyboard customization #23
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
This was referenced Aug 1, 2024
burkfers
reviewed
Aug 1, 2024
Co-authored-by: burkfers <finrod09@users.noreply.github.com>
Co-authored-by: burkfers <finrod09@users.noreply.github.com>
burkfers
reviewed
Aug 2, 2024
Co-authored-by: burkfers <finrod09@users.noreply.github.com>
Co-authored-by: burkfers <finrod09@users.noreply.github.com>
Co-authored-by: burkfers <finrod09@users.noreply.github.com>
Co-authored-by: burkfers <finrod09@users.noreply.github.com>
Co-authored-by: burkfers <finrod09@users.noreply.github.com>
Co-authored-by: burkfers <finrod09@users.noreply.github.com>
Co-authored-by: burkfers <finrod09@users.noreply.github.com>
Co-authored-by: burkfers <finrod09@users.noreply.github.com>
Co-authored-by: burkfers <finrod09@users.noreply.github.com>
Co-authored-by: burkfers <finrod09@users.noreply.github.com>
Co-authored-by: burkfers <finrod09@users.noreply.github.com>
Co-authored-by: burkfers <finrod09@users.noreply.github.com>
Co-authored-by: burkfers <finrod09@users.noreply.github.com>
burkfers
reviewed
Aug 6, 2024
fw/compile-firmware.md
Outdated
| This page details how to compile your own firmware. Building from source is useful to people who want to customize their keyboard and keymaps beyond what Via offers. This involves using a command-line interface, writing C code, and compiling this code into the final firmware file. | ||
| This page details how to build your own firmware. | ||
| Building from source is useful to people who want to customize their keyboard and keymaps beyond what Via offers. | ||
| You will have to modify the keymap `C` code, and from there compile your firmware either using Github actions or the local command line. | ||
|
|
||
| If that seems too complicated, you can also use one of the default releases, or VIA. |
There was a problem hiding this comment.
Doesn't one include the other? Perhaps "you can also use one of the defalult releases using via".
"default releases" should also link to the releases page.
There was a problem hiding this comment.
added release link. not sure what you mean with the other
Co-authored-by: burkfers <finrod09@users.noreply.github.com>
Co-authored-by: burkfers <finrod09@users.noreply.github.com>
Co-authored-by: burkfers <finrod09@users.noreply.github.com>
burkfers
reviewed
Aug 6, 2024
Co-authored-by: burkfers <finrod09@users.noreply.github.com>
Co-authored-by: burkfers <finrod09@users.noreply.github.com>
Co-authored-by: burkfers <finrod09@users.noreply.github.com>
burkfers
approved these changes
Aug 6, 2024
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.
This PR has an overall goal of detailing more and simplifying more the process of using and customizing your keyboard.
Until now, everything was a bit mish-mashed, so better separation was needed. The documentation on how to compile your firmware was also outdated.
how to compile your firmwarefrom bk's bastardkb-qmk repo to the docshow to usepage, which details daily use:fw/compile-firmware.mdpage, updated with the removal of old hardware, which details how to compile your own firmware with QMKI chose to give
Using VIAmore visibility by adding it directly at the end of each build guide, while theUsing QMKget its own page. This makes the pages less information-heavy, and we can be more detailed on the QMK pages.On top of this, overall cleanups:
how to compile your firmwarepage to reflect removal of old hardware