-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
bmi accel works, better tps with bmi
- Loading branch information
1 parent
9eff429
commit e7db236
Showing
5 changed files
with
73 additions
and
70 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,52 +1,52 @@ | ||
# Contributing | ||
|
||
Thanks for being interested in contributing to this project! This document describes | ||
what you need to know to get started with the code. | ||
|
||
|
||
## Installing the dependencies | ||
|
||
First, install the `Rust` programming language by following the instructions at | ||
[rustup.rs](https://rustup.rs). | ||
|
||
Next, install `libclang`, which is used by the | ||
[`ovr_overlay`](https://crates.io/crates/ovr_overlay) bindings for OpenVR. For windows, | ||
use [this] link. For Linux, simply `sudo apt-get install -y libclang-dev`. | ||
|
||
[this]: https://github.com/llvm/llvm-project/releases/download/llvmorg-14.0.5/LLVM-14.0.5-win64.exe | ||
|
||
You will also need SteamVR installed. | ||
|
||
### Steam Deck | ||
|
||
If you are building on the steam deck, be sure that you have all the necessary libraries | ||
for native development installed. To get them, follow [these] instructions. | ||
|
||
[these]: https://www.reddit.com/r/SteamDeck/comments/t92ozw/for_compiling_c_code/ | ||
|
||
|
||
## Building | ||
|
||
`cargo` is the build tool for rust. You can `cargo run` to run the code, `cargo check` | ||
to check if your code compiles, and `cargo test` to run tests. You can also do | ||
`--release` to generate an optimized release mode version. This will take longer to | ||
compile but will run significantly faster. | ||
|
||
|
||
## Documentation | ||
|
||
Documentation is autogenerated by cargo and can be viewed in a web browser with | ||
`cargo doc --all --open --no-deps --document-private-items`. You can run | ||
`cargo doc --help` to learn more about what those flags do. The documentation is also | ||
automatically published to github pages for every commit on the `main` branch [here]. | ||
|
||
[here]: https://slimevr.github.io/SlimeVR-Overlay/skeletal_model | ||
|
||
|
||
## Code Style | ||
|
||
All code is autoformatted by `cargo fmt`. We suggest turning on autoformatting on save | ||
in your IDE, otherwise you can just run `cargo fmt` on the command line. Also, all files | ||
should end in a newline and have extra whitespace trimmed. | ||
|
||
Its also a good idea to run `cargo clippy` to fix the style lints it generates. | ||
# Contributing | ||
|
||
Thanks for being interested in contributing to this project! This document describes | ||
what you need to know to get started with the code. | ||
|
||
|
||
## Installing the dependencies | ||
|
||
First, install the `Rust` programming language by following the instructions at | ||
[rustup.rs](https://rustup.rs). | ||
|
||
Next, install `libclang`, which is used by the | ||
[`ovr_overlay`](https://crates.io/crates/ovr_overlay) bindings for OpenVR. For windows, | ||
use [this] link. For Linux, simply `sudo apt-get install -y libclang-dev`. | ||
|
||
[this]: https://github.com/llvm/llvm-project/releases/download/llvmorg-14.0.5/LLVM-14.0.5-win64.exe | ||
|
||
You will also need SteamVR installed. | ||
|
||
### Steam Deck | ||
|
||
If you are building on the steam deck, be sure that you have all the necessary libraries | ||
for native development installed. To get them, follow [these] instructions. | ||
|
||
[these]: https://www.reddit.com/r/SteamDeck/comments/t92ozw/for_compiling_c_code/ | ||
|
||
|
||
## Building | ||
|
||
`cargo` is the build tool for rust. You can `cargo run` to run the code, `cargo check` | ||
to check if your code compiles, and `cargo test` to run tests. You can also do | ||
`--release` to generate an optimized release mode version. This will take longer to | ||
compile but will run significantly faster. | ||
|
||
|
||
## Documentation | ||
|
||
Documentation is autogenerated by cargo and can be viewed in a web browser with | ||
`cargo doc --all --open --no-deps --document-private-items`. You can run | ||
`cargo doc --help` to learn more about what those flags do. The documentation is also | ||
automatically published to github pages for every commit on the `main` branch [here]. | ||
|
||
[here]: https://slimevr.github.io/SlimeVR-Overlay/skeletal_model | ||
|
||
|
||
## Code Style | ||
|
||
All code is autoformatted by `cargo fmt`. We suggest turning on autoformatting on save | ||
in your IDE, otherwise you can just run `cargo fmt` on the command line. Also, all files | ||
should end in a newline and have extra whitespace trimmed. | ||
|
||
Its also a good idea to run `cargo clippy` to fix the style lints it generates. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,16 @@ | ||
# Autoupdater | ||
|
||
The SlimeVR autoupdater manages updating all the software for SlimeVR on a user's | ||
computer. It does not handle updates of firmware. | ||
|
||
It reads a `version.yaml` file from a github release to determine the versions of the | ||
software to download, then fetches them and installs them. | ||
|
||
Long term, we may use this to replace most or all of the business logic of the current | ||
[SlimeVR Web Installer](https://github.com/SlimeVR/SlimeVR-Installer). | ||
|
||
## Project Status | ||
This is abandoned due to lack of interested developers. | ||
|
||
When being actively developed, the Yaml description and serialization was complete | ||
already. | ||
# Autoupdater | ||
|
||
The SlimeVR autoupdater manages updating all the software for SlimeVR on a user's | ||
computer. It does not handle updates of firmware. | ||
|
||
It reads a `version.yaml` file from a github release to determine the versions of the | ||
software to download, then fetches them and installs them. | ||
|
||
Long term, we may use this to replace most or all of the business logic of the current | ||
[SlimeVR Web Installer](https://github.com/SlimeVR/SlimeVR-Installer). | ||
|
||
## Project Status | ||
This is abandoned due to lack of interested developers. | ||
|
||
When being actively developed, the Yaml description and serialization was complete | ||
already. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters