Skip to content

Commit

Permalink
Add Rust usage note to SDK Usage (#72)
Browse files Browse the repository at this point in the history
  • Loading branch information
Sainan authored Jan 19, 2024
1 parent 9e8e3b1 commit 86af22b
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions SDK_USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,18 @@ If you wish to use the SDK, you should be dynamically linking to the `wooting-an

To get started, make sure you have the SDK & Wooting plugin installed. Follow the installation instructions from the [SDK Readme](https://github.com/WootingKb/wooting-analog-sdk).

### C/C++

Then download & extract the `.tar.gz` for the platform you’re targeting from the [latest release](https://github.com/WootingKb/wooting-analog-sdk/releases). Inside the `$extract/wrapper` directory you’ll find the wrapper lib you should link to and all the headers you may need.

### Rust

Add the following to your crate's dependencies:

```TOML
wooting-analog-wrapper = { git = "https://github.com/WootingKb/wooting-analog-sdk" }
```

## Keycodes

By default the SDK will use the [USB HID codes (see table 10.6)](https://www.win.tue.nl/~aeb/linux/kbd/scancodes-10.html#scancodesets) to identify keys. This can be changed using the [Set Keycode Mode](#set-keycode-mode) function, which changes the keycodes taken by `read_analog` and the keycodes given in `read_full_buffer`. The available options are:
Expand Down

0 comments on commit 86af22b

Please sign in to comment.