You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-4Lines changed: 8 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -69,14 +69,18 @@ The default location for navigation data is `work/NavigationData`.
69
69
70
70
## Building the Sample Aircraft (MSFS2020)
71
71
72
-
Before building, make sure you have properly created and set an `.env` file in `example/gauge`! An example can be found in the `.env.example` file in that directory. Replace with your credentials
72
+
> [!NOTE]
73
+
> This project is only meant to be tested in MSFS2020. We will add an example for MSFS2024 in the future.
74
+
75
+
> [!IMPORTANT]
76
+
> Before building, make sure you have properly created and set an `.env` file in `example/gauge`! An example can be found in the `.env.example` file in that directory. Replace with your credentials.
73
77
74
78
1. Download and install [Bun](https://bun.sh/docs/installation)
75
-
2. Open the `msfs-navigation-data-interface` folder in a terminal
79
+
2. Open this repository in a terminal
76
80
3. Run `bun i` the first time you build, in order to install dependencies
77
-
4. Change directory to `example/gauge` using `cd example/gauge`
81
+
4. Change directory to [`example/gauge`](example/gauge/) using `cd example/gauge`
78
82
5. Run `bun run build` to build into the `PackageSources` folder of the aircraft sample (or `bun run dev` to build into the `Packages` folder of the aircraft and listen to changes in the source).
79
-
6. Make sure the WASM module is included in the [`panel`](example/aircraft/PackageSources/SimObjects/Airplanes/Navigraph_Navigation_Data_Interface_Aircraft/panel) folder! Look at either [Including in Your Aircraft](#including-in-your-aircraft) or [Building the WASM Module Yourself](#building-the-wasm-module-yourself)for info on that
83
+
6. Make sure the WASM module is included in the [`panel`](example/aircraft/PackageSources/SimObjects/Airplanes/Navigraph_Navigation_Data_Interface_Aircraft/panel) folder! Look at either [Including in Your Aircraft](#including-in-your-aircraft) or [Building the WASM Module Yourself](#building-the-wasm-module-yourself)instructions
80
84
7. Open the `example/aircraft/NavigationDataInterfaceAircraftProject.xml` file in the simulator and build there
0 commit comments