Skip to content

Commit 56a743b

Browse files
authored
Add more info to Readme (Sequal32#15)
1 parent 2893c6f commit 56a743b

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

Readme.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
![crates.io](https://img.shields.io/crates/v/simconnect)
22
# SimConnect Bindings for Rust
3+
4+
## Requirements
5+
- [CLang](https://clang.llvm.org/get_started.html) (See the [Rust Bindgen Documentation](https://rust-lang.github.io/rust-bindgen/requirements.html))
6+
- MSVC x64 Rust build (`x86_64-pc-windows-msvc`, see [The rustup book](https://rust-lang.github.io/rustup/installation/windows.html))
7+
38
## Using
49
Add this to your `Cargo.toml`
510
```toml
@@ -10,9 +15,8 @@ simconnect = "0.3.1"
1015
## Building
1116
*The SimConnect binaries are included within this repository, but they may not be up-to-date.*
1217

13-
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).
14-
2. run `cargo build`
15-
3. Add `use simconnect` at the top of your file
18+
1. run `cargo build`
19+
2. Add `use simconnect` at the top of your file
1620

1721
## Example
1822
Read float position data
@@ -28,8 +32,5 @@ cargo run --example aircraft_updates_on_change
2832

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

31-
## Building
32-
*The SimConnect.dll is included in this repository, but might not be up-to-date*
33-
3435
### Remarks
3536
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 commit comments

Comments
 (0)