Update README.md

This commit is contained in:
Ben Reaves
2019-08-06 00:22:28 -05:00
committed by GitHub
parent d15a177bfd
commit 70e2227d96

View File

@@ -19,6 +19,16 @@ Remaps your keyboard to behave more like you're on a mac again and below is how
- ~~Modify existing Terminal app keymap profiles (optional and with confirmation) - Copy, Paste, New Tab, etc will be remapped to use Win/Super in the physical Command (or Alt key) position.~~ - ~~Modify existing Terminal app keymap profiles (optional and with confirmation) - Copy, Paste, New Tab, etc will be remapped to use Win/Super in the physical Command (or Alt key) position.~~
## What does Kinto require?
- Python
- systemd
- x11
Any Linux distro that uses systemd. Compatibility can easily be expanded, but currently I am only writing and testing this with systemd services.
X11 is the only other requirement. Wayland can be supported, but will require a replacement for xprop - any app or DE plugin that can be made aware of the active application name and trigger scripts is sufficient. If this alternative is found then it may also replace xprop, assuming it is also compatible under x11.
## How to install ## How to install
1. clone this repo 1. clone this repo
@@ -38,6 +48,35 @@ sudo apt install python3
./install.py ./install.py
``` ```
## How to Control Kinto
Under systemd this is how you control Kinto.
Status
```
systemctl --user status keyswap
```
Stop
```
systemctl --user stop keyswap
```
Start
```
systemctl --user start keyswap
```
Enable
```
systemctl --user enable keyswap
```
Disable
```
systemctl --user disable keyswap
```
## Troubleshooting ## Troubleshooting
If your keyboard is not being autodetected and configured then please run `xinput list`, if you are on linux, and copy the output into a ticket under issues. If your keyboard is not being autodetected and configured then please run `xinput list`, if you are on linux, and copy the output into a ticket under issues.
@@ -55,6 +94,21 @@ This is required so that Apple and Windows keyboards can co-exist with the exact
Other solutions may involve implementing a separate Mac system option in Kinto with a keyswap specific to a usb hub situation, however it will not be possible to have a Windows keyboard (aka internal laptop keyboard) working with the same keymap at the same time. Other solutions may involve implementing a separate Mac system option in Kinto with a keyswap specific to a usb hub situation, however it will not be possible to have a Windows keyboard (aka internal laptop keyboard) working with the same keymap at the same time.
## Debugging
If you would like you can disable the Kinto keyswap service and run xactive.sh directly so that you can monitor the switching process between Windows and the terminal. First you will want to view the keyswap service file to make sure you pass the correct arguments to xactive.sh. Most configurations do not really need the specific internal or usb id of your keyboard, but chromebook installs do require it.
```
cat ~/.config/systemd/user/keyswap.service
```
```
systemctl --user disable keyswap
systemctl --user stop keyswap
~/.config/xactive.sh mac 12 0 none
```
## Contributing ## Contributing
I welcome any and all contributors who want to contribute something to this project. I welcome any and all contributors who want to contribute something to this project.