Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ItsZariep authored Sep 17, 2024
1 parent 36d2cb4 commit 10a156e
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ To build GXCapIndicator, choose the backend you want to use:

### With Evdev Backend

```sh
```ini
make
```

### With X11 Backend

```sh
```ini
make WITHX11=1
```

Expand All @@ -34,14 +34,16 @@ GXCapIndicator supports two backends for fetching key status: X11 and Evdev. Eac

### X11 Backend
- Uses `XkbGetState` to fetch the key status.
- Checks cannot be done in real time without generating high CPU usage.
- Some options are not available:
- **Initial Visual State**: Cannot set the initial visual state of Caps Lock/Num Lock (unnecessary with XkbGetState).

### Evdev Backend
- Uses `libinput_event_get_keyboard_event` to fetch the key status.
- Checks can be real time without high CPU Usage
- Some options are not available:
- **Update Rate**: Polling rate is fixed and cannot be adjusted.
- **Toggle Functionality**: Can't be implemented without root access.
- **Update Rate**: Cannot change update rate because polling intercepts events (and is not really necessary because there is no CPU usage penalty).
- **Toggle**: Can't be implemented without root access.

## Configuration

Expand All @@ -53,4 +55,4 @@ You can configure GXCapIndicator with the integrated GUI (`settings` in indicato
| `shownum` | Enables the Num Lock key indicator | `0`, `1` | `1` | `shownum=1` | All |
| `updrate` | Sets the update rate | (Number) | `0` | `updrate=0` | X11 |
| `vcapstate` | Sets the initial visual state of Caps Lock | `0`, `1` | `0` | `vcapstate=0` | Evdev |
| `vnumstate` | Sets the initial visual state of Num Lock | `0`, `1` | `0` | `vnumstate=0` | Evdev |
| `vnumstate` | Sets the initial visual state of Num Lock | `0`, `1` | `0` | `vnumstate=0` | Evdev |

0 comments on commit 10a156e

Please sign in to comment.