Skip to content

Commit f86c345

Browse files
committed
Add build and run instructions
1 parent 3f1e7ab commit f86c345

File tree

2 files changed

+28
-6
lines changed

2 files changed

+28
-6
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,11 @@ htmlgauge00=WasmInstrument/WasmInstrument.html?wasm_module=gauge_logic.wasm&wasm
8080
---
8181

8282
## Getting started
83-
* [Check out the examples](examples/)
83+
```bash
84+
$ cd examples/nvg
85+
$ cargo build --target wasm32-wasip1
86+
```
87+
* [Check out the other examples](examples/)
8488
* [Download the MSFS SDK](https://docs.flightsimulator.com/html/Introduction/SDK_Overview.htm)
8589

8690
## Further reading

examples/README.md

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,31 @@
1-
# Examples
1+
## Nvg
2+
NanoVG demo to show how to draw a custom Gauge in an aircraft.
3+
4+
* Compiles to WASM to be [loaded by MSFS](https://docs.flightsimulator.com/html/mergedProjects/How_To_Make_An_Aircraft/Contents/Instruments/Creating_WASM_Gauges.htm).
5+
* Similar to how the MSFS Sample [GaugeAircraft](https://docs.flightsimulator.com/html/Samples_And_Tutorials/Samples/SimObjects_Aircraft/GaugeAircraft.htm) works.
6+
7+
#### Building
8+
```bash
9+
$ cd examples/nvg
10+
$ cargo build --target wasm32-wasip1
11+
```
12+
#### Running
13+
To see it in action you have to load an aircraft into MSFS which uses the compiled wasm file.
14+
15+
[MrMinimal's Rust Aircraft Template](https://github.com/MrMinimal/msfs-rust-aircraft) shows how that can be done.
16+
17+
---
218

319
## Client Data
420
SimConnect demo to show how a standalone application would interact with MSFS.
521

22+
---
23+
624
## Log
725
SimConnect demo printing data from MSFS in a standalone application.
826

9-
## Nvg
10-
NanoVG demo to show how to draw a custom Gauge in an aircraft.
27+
---
1128

12-
* Compiles to WASM to be [loaded by MSFS](https://docs.flightsimulator.com/html/mergedProjects/How_To_Make_An_Aircraft/Contents/Instruments/Creating_WASM_Gauges.htm).
13-
* Similar to how the MSFS Sample [GaugeAircraft](https://docs.flightsimulator.com/html/Samples_And_Tutorials/Samples/SimObjects_Aircraft/GaugeAircraft.htm) works.
29+
## Other Projects / Aircraft
30+
If you want to see msfs-rs fully integrated in working aircraft
31+
* [FlyByWire A32X and A380](https://github.com/flybywiresim/aircraft)

0 commit comments

Comments
 (0)