Cleanup the docs

This commit is contained in:
Mihai Dinculescu
2022-10-19 11:14:51 +01:00
parent 165432874b
commit a868d09b6e
10 changed files with 21 additions and 133 deletions

View File

@@ -2,6 +2,8 @@
[![CI][ci_badge]][ci]
An opinionated SimConnect SDK that encapsulates the C API fully and optimizes for developer experience.
## Usage
```toml
@@ -15,6 +17,7 @@ use simconnect_sdk::{Notification, SimConnect, SimConnectObject};
/// A data structure that will be used to receive data from SimConnect.
#[derive(Debug, Clone, SimConnectObject)]
#[simconnect(period = "second")]
#[allow(dead_code)]
struct GpsData {
#[simconnect(name = "PLANE LATITUDE", unit = "degrees")]
lat: f64,
@@ -25,7 +28,7 @@ struct GpsData {
}
fn main() -> Result<(), Box<dyn std::error::Error>> {
let client = SimConnect::new("Simple Program");
let client = SimConnect::new("Receiving data example");
match client {
Ok(mut client) => {