Skip to content

Commit

Permalink
Add more info to Readme (Sequal32#15)
Browse files Browse the repository at this point in the history
  • Loading branch information
markusa380 authored Mar 25, 2024
1 parent 2893c6f commit 56a743b
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
![crates.io](https://img.shields.io/crates/v/simconnect)
# SimConnect Bindings for Rust

## Requirements
- [CLang](https://clang.llvm.org/get_started.html) (See the [Rust Bindgen Documentation](https://rust-lang.github.io/rust-bindgen/requirements.html))
- MSVC x64 Rust build (`x86_64-pc-windows-msvc`, see [The rustup book](https://rust-lang.github.io/rustup/installation/windows.html))

## Using
Add this to your `Cargo.toml`
```toml
Expand All @@ -10,9 +15,8 @@ simconnect = "0.3.1"
## Building
*The SimConnect binaries are included within this repository, but they may not be up-to-date.*

1. Install [CLang](https://clang.llvm.org/get_started.html). More information available at the [Rust Bindgen Documentation](https://rust-lang.github.io/rust-bindgen/requirements.html).
2. run `cargo build`
3. Add `use simconnect` at the top of your file
1. run `cargo build`
2. Add `use simconnect` at the top of your file

## Example
Read float position data
Expand All @@ -28,8 +32,5 @@ cargo run --example aircraft_updates_on_change

*You must have SimConnect.dll in the same directory as the compiled exe for it to run (e.g. in )*

## Building
*The SimConnect.dll is included in this repository, but might not be up-to-date*

### Remarks
I have not tested every single function from the api. If you find an error, feel free to make an issue or a pull request.

0 comments on commit 56a743b

Please sign in to comment.