Skip to content

Commit

Permalink
Add instructions for devs on using as a crate
Browse files Browse the repository at this point in the history
  • Loading branch information
Kuuuube committed Jan 18, 2025
1 parent 35a80fb commit 593642b
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,3 +137,29 @@ Note: Motivity has been superceded by `Synchronous`
```
rawaccel_convert classic --sens=0.25 --accel=0.0315 --captype=input --capin=34 --power=2.5 --dpi=1600
```
# For Developers
Rawaccel Convert doubles as a crate that can be added as a dependency to your Rust projects.
This project is zero-depenency and only requires the Rust std and core language features. Because of this, it will barely add any extra compile time to your project.
Due to it not being published on [crates.io](https://crates.io/), adding the crate is a little different from most. Simply add the git repo and commit hash to your `Cargo.toml`.
## Examples
Replace `COMMIT_HASH_GOES_HERE` with the commit hash you wish to use.
```
[dependencies]
rawaccel_convert = { git = "https://github.com/Kuuuube/rawaccel_convert.git", rev = "COMMIT_HASH_GOES_HERE" }
```
For example, to use version `0.1.3` the commit hash is `1b090cb684fc47d211ef5c6d1985572fb338ebc9`:
```
[dependencies]
rawaccel_convert = { git = "https://github.com/Kuuuube/rawaccel_convert.git", rev = "1b090cb684fc47d211ef5c6d1985572fb338ebc9" }
```
To see a working project that uses `rawaccel_convert` as a dependency, check out [Rawaccel Convert GUI](https://github.com/Kuuuube/rawaccel-convert-gui).

0 comments on commit 593642b

Please sign in to comment.