Skip to content

Commit

Permalink
Update README with trackpoint info
Browse files Browse the repository at this point in the history
  • Loading branch information
infused-kim committed Jan 18, 2024
1 parent ccc1105 commit fd2f3b6
Showing 1 changed file with 18 additions and 61 deletions.
79 changes: 18 additions & 61 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,27 @@
# ZMK Firmware: Fork of urob's fork
# ZMK with Kim's PS/2 Mouse & Trackpoint Driver + Urob's Improvements

This is my fork of urob's personal ZMK fork containing various experimental features. ~~It is regularly rebased
onto the latest upstream.~~
This branch includes the latest version of the PS/2 Mouse & Trackpoint driver.

I made this fork while we wait for urob to update his.
You can [follow the comments in this zmk-config commit](https://github.com/infused-kim/zmk-config/commit/4134157ea054192bdc063ee4451ab780d7f01b8d) to figure out how to configure your PS/2 mouse or trackpoint.

This is rebased with zmk/main as of 2024-01-06.
You can also refer to the following PRs for more info:

> **Warning**
>
> This fork uses the experimental and potentially unstable zephyr 3.5 version.
>
> If you don't want to take the risk of running this experimental version and don't need mouse keys, you can use the [urob/no-mouse branch](https://github.com/infused-kim/zmk/tree/urob/no-mouse).
- [ZMK PR #1751 - PS/2 Mouse & Trackpoint Driver](https://github.com/zmkfirmware/zmk/pull/1751)
- [Zephyr PR #15 - PS/2 driver using GPIO and UART](https://github.com/zmkfirmware/zephyr/pull/15))

On top of that it contains the improvements from [the popular fork by urob](https://github.com/urob/zmk). You can [learn more about the benefits of his fork in his zmk-config](https://github.com/urob/zmk-config).

Due to the recent mouse code changes in zmk, it's based on the experimental zephyr 3.5 version, which may have bugs or stability issues. You can [learn more about it in this blog post draft](https://deploy-preview-1995--zmk.netlify.app/blog/2024/01/31/zephyr-3-5).

This is rebased with zmk/main as of 2024-01-16.

## Included features and PRs...

Below is a list of features currently included in the `main` branch _on top of_
the official ZMK master branch.

- **PS/2 Mouse & Trackpoint Driver** ([ZMK PR #1751](https://github.com/zmkfirmware/zmk/pull/1751) & [Zephyr PR #15](https://github.com/zmkfirmware/zephyr/pull/15))
- **Input Config - Auto toggle layer on mouse movement**
- **Mouse Keys using Zephyr 3.5** ([PR #2027](https://github.com/zmkfirmware/zmk/pull/2027) + [PR #1995](https://github.com/zmkfirmware/zmk/pull/1995))
- **swapper** (PR [#1366](https://github.com/zmkfirmware/zmk/pull/1366)) - official PR + fixes needed for Zephyr 3.2 and 3.5
- **smart-word** (PR [#1451](https://github.com/zmkfirmware/zmk/pull/1451)) - official PR, updated to Zephyr-3.2
Expand All @@ -26,59 +30,12 @@ the official ZMK master branch.
- **adv360pro** (PR [#1454](https://github.com/zmkfirmware/zmk/pull/1454)) - offical PR
- **zen-tweaks** - [display & battery improvements](https://github.com/caksoylar/zmk/tree/caksoylar/zen-v1%2Bv2) by Cem Aksoylar

Thanks to caksoylar for figuring out the changes needed for the swapper PR. As well as to him and petejohanson for their work on the zephyr 3.5 mouse PR.
Thanks and credits go out to krikun98, petejohanson and caksoylar for their work on the mouse keys code.

As well as to caksoylar for figuring out the changes needed for the swapper PR.

And of course to urob for his amazing fork.

## How to use it

### Adjust your mouse key config

The mouse key config changed slightly compared to the old version.

The scroll behavior has been renamed from `&mwh` to `msc`.

And the parameters from `SCROLL_XXX` to `SCRL_XXX`.

You can see a [working example here](https://github.com/infused-kim/zmk-config/blob/main/config/includes/mouse_keys.dtsi).


### Github Actions

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:

```yaml
manifest:
remotes:
- name: zmkfirmware
url-base: https://github.com/zmkfirmware
- name: urob
url-base: https://github.com/urob
- name: infused-kim
url-base: https://github.com/infused-kim
projects:
- name: zmk
remote: infused-kim
revision: urob/mouse
import: app/west.yml
self:
path: config
```
And `.github/workflows/build.yml` with...

```yaml
on: [push, pull_request, workflow_dispatch]
jobs:
build:
uses: petejohanson/zmk/.github/workflows/build-user-config.yml@core/zephyr-3.5-update
```

### VSCode Build

- Follow the [official toolchain setup instructions](https://zmk.dev/docs/development/setup)
- Switch the zmk code to this branch
- Switch the zephyr code to the [petejohanson/zmk-v2.3.0-with-fixes](https://github.com/petejohanson/zephyr/tree/v3.5.0%2Bzmk-fixes) branch
- In VSCode run the `Remote Containers: Rebuild Container Without Cache` action [as described here](https://zmk.dev/blog/2023/04/06/zephyr-3-2)
You can [follow the comments in this zmk-config commit](https://github.com/infused-kim/zmk-config/commit/4134157ea054192bdc063ee4451ab780d7f01b8d) to figure out how to configure your PS/2 mouse or trackpoint.

0 comments on commit fd2f3b6

Please sign in to comment.