summaryrefslogtreecommitdiff
path: root/README.md
AgeCommit message (Collapse)Author
2024-04-15Minor docs update (#445)ReFil
2024-04-15Document new layer colors and modifier color configuration option (#431)Keeley Hoek
Co-authored-by: ReFil <31960031+ReFil@users.noreply.github.com>
2024-02-05Makefile enhancements to optimize local workflows (#363)Thomas Huber
- Enhance the Makefile to enable firmware building exclusively for the left side. To modify the keymap, flashing only the left side's firmware suffices. This change facilitates the creation of firmware for the left side only, thereby expediting the build process. Usage: make left This update maintains existing functionality. Without specifying the left target, firmware for both halves will be generated. - Add separate make targets to clean firmware and docker image Add targets clean_firmware and clean_image independently while maintaing clean to run both - Ensure files modified by the build process are reset at the end The current build process dynamically generates the content of the version macro in config/version.dtsi to enable users to print out the precise version and commit the firmware was built on via a keybinding on the keymap. This change ensurs that the changes to this macro file are reset at the end of the build process to ensure it isn't shown as modified and added to keymap commit changes.
2023-11-16Version compiled FW with automatic macro (#267)ReFil
* Version compiled FW with hash Auto generates a macro to type out version info, local and github compilation now includes commit hash and timestamp in final uf2 files * Fix local builds makefile doesn't like the script returning the macro, directed to null for local builds as version.dtsi file accessible
2023-11-08Document new NKRO settings (#264)ReFil
* Document new NKRO settings * Update CHANGELOG.md
2023-11-02Improve documentation based on feedback (#260)ReFil
* Improve documentation based on feedback * Update README.md * Update CHANGELOG.md
2023-10-20Update ZMK (#248)ReFil
Tweaks to point to new ZMK branch, changes to support this.
2023-10-09Further documentation work (#241)ReFil
* Minor cleanup, change date format, add beta testing * Update CHANGELOG.md
2023-09-07Readme rewrite (#222)ReFil
2023-07-28Add instructions for upgrading from V2 to V3 in README (#197)Santhosh Kannan
This commit adds a new section in the README.md file detailing instructions for users upgrading from V2 to V3.
2023-04-07Refine wording of steps in firmware flashing.Tom Plunket
2023-04-02Provide flashing instructions, point at GUI editor, and format support links.Tom Plunket
2022-11-18Readme CleanupReFil
2022-11-18Update README.mdReFil
2022-10-25readme: include note about requiring podman or docker for local buildClayton Craft
2022-10-11Update docsJosh French
2022-09-07Update README.mdKinesis Keyboards
2022-05-20Add local build option with Docker and READMERyan Winchester