18 Commits

Author SHA1 Message Date
ReFil b9b694c9dd Minor docs update (#445) 2024-04-15 12:36:47 +01:00
Keeley Hoek 41e734c1ee Document new layer colors and modifier color configuration option (#431)
Co-authored-by: ReFil <31960031+ReFil@users.noreply.github.com>
2024-04-15 12:27:42 +01:00
Thomas Huber cbc0656668 Makefile enhancements to optimize local workflows (#363)
- 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.
2024-02-05 09:55:24 +00:00
ReFil cdcec22e60 Version compiled FW with automatic macro (#267)
* 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-16 07:49:39 +00:00
ReFil 44a42af666 Document new NKRO settings (#264)
* Document new NKRO settings

* Update CHANGELOG.md
2023-11-08 13:45:26 +00:00
ReFil b7ee938784 Improve documentation based on feedback (#260)
* Improve documentation based on feedback

* Update README.md

* Update CHANGELOG.md
2023-11-02 20:13:39 +00:00
ReFil 71a5ba15e5 Update ZMK (#248)
Tweaks to point to new ZMK branch, changes to support this.
2023-10-20 21:55:37 +01:00
ReFil 82494e7740 Further documentation work (#241)
* Minor cleanup, change date format, add beta testing

* Update CHANGELOG.md
2023-10-09 09:34:58 +00:00
ReFil 45fca6f601 Readme rewrite (#222) 2023-09-07 09:09:48 +00:00
Santhosh Kannan 2d369451ae Add instructions for upgrading from V2 to V3 in README (#197)
This commit adds a new section in the README.md file detailing instructions for users upgrading from V2 to V3.
2023-07-28 08:58:15 +00:00
Tom Plunket 9a5d22ca99 Refine wording of steps in firmware flashing. 2023-04-07 08:37:58 -07:00
Tom Plunket 603133f060 Provide flashing instructions, point at GUI editor, and format support links. 2023-04-02 20:14:04 -07:00
ReFil 49fb545310 Readme Cleanup 2022-11-18 22:32:54 +00:00
ReFil 54abe0b531 Update README.md 2022-11-18 18:09:43 +00:00
Clayton Craft 45ea621702 readme: include note about requiring podman or docker for local build 2022-10-25 11:44:54 -07:00
Josh French b3e58a53b8 Update docs 2022-10-11 11:24:22 -04:00
Kinesis Keyboards 16dcdb9fae Update README.md 2022-09-07 15:51:27 -07:00
Ryan Winchester 068b1ff56a Add local build option with Docker and README 2022-05-20 16:59:56 -03:00