diff --git a/README.md b/README.md index f112b0f9705..42bfec787c7 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,55 @@ -# Zephyr™ Mechanical Keyboard (ZMK) Firmware +# ZMK Firmware: Personal fork -[![Discord](https://img.shields.io/discord/719497620560543766)](https://zmk.dev/community/discord/invite) -[![Build](https://github.com/zmkfirmware/zmk/workflows/Build/badge.svg)](https://github.com/zmkfirmware/zmk/actions) -[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md) +This is my personal ZMK fork containing various experimental features used in +my [zmk-config](https://github.com/urob/zmk-config/). This branch is up to date +with the latest ZMK upgrade to Zephyr 3.5. A legacy version +of this branch for Zephyr 3.2 can be found [here](https://github.com/urob/zmk/tree/main-3.2). -[ZMK Firmware](https://zmk.dev/) is an open source ([MIT](LICENSE)) keyboard firmware built on the [Zephyr™ Project](https://www.zephyrproject.org/) Real Time Operating System (RTOS). ZMK's goal is to provide a modern, wireless, and powerful firmware free of licensing issues. +**Note**: I am in the process of moving to a modular ZMK setup and no longer use this branch myself. +Instead, I am building against [going-modular](https://github.com/urob/zmk/tree/going-modular), +which closely tracks upstream ZMK master (as of today there are only two additional commits on top +of master), adding all other features via ZMK modules. -Check out the website to learn more: https://zmk.dev/. +--- -You can also come join our [ZMK Discord Server](https://zmk.dev/community/discord/invite). +Note that the branch now includes the official mouse PR #2027. If you are updating from an earlier +version with the original mouse PR #778, then the following +adjustments are necessary in your `zmk-config`: -To review features, check out the [feature overview](https://zmk.dev/docs/). ZMK is under active development, and new features are listed with the [enhancement label](https://github.com/zmkfirmware/zmk/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement) in GitHub. Please feel free to add 👍 to the issue description of any requests to upvote the feature. +- `&mwh` --> `&msc` +- `MOVE_VERT` --> `MOVE_Y` or `MOVE_LEFT`/`MOVE_RIGHT` +- `MOVE_HOR` --> `MOVE_X` or `MOVE_UP`/`MOVE_DOWN` +- `SCROLL_VERT` --> `MOVE_Y` or `SCRL_UP`/`SCRL_DOWN` +- `SCROLL_HOR` --> `MOVE_X` or `SCRL_LEFT`/`SCRL_RIGHT` + +E.g., this is my current [mouse +configuration](https://github.com/urob/zmk-config/blob/main/config/mouse.dtsi) +using the new api. + +--- + +Below is a list of features currently included in this branch _on top of_ +the official ZMK master branch. + +- **pointer movement/scrolling** - PR #2027 +- **tri-state (aka swapper)** - PR [#1366](https://github.com/zmkfirmware/zmk/pull/1366) +- **smart-word** (PR [#1451](https://github.com/zmkfirmware/zmk/pull/1451)) +- **on-release-for-tap-preferred** - [tweak](https://github.com/celejewski/zmk/commit/d7a8482712d87963e59b74238667346221199293) by Andrzej +- **zen-tweaks** - [display & battery improvements](https://github.com/caksoylar/zmk/tree/caksoylar/zen-v1%2Bv2) by Cem Aksoylar + +In order to use this branch with Github Actions, replace the contents of `west.yml` in +your `zmk-config/config` directory with the following contents: + +``` +manifest: + remotes: + - name: urob + url-base: https://github.com/urob + projects: + - name: zmk + remote: urob + revision: main + import: app/west.yml + self: + path: config +```