Skip to content

Commit aea4a34

Browse files
committed
docs: updated doc accordingly to previous changes.
1 parent 1e68421 commit aea4a34

File tree

1 file changed

+22
-11
lines changed

1 file changed

+22
-11
lines changed

README.md

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -70,26 +70,37 @@ The default location for navigation data is `work/NavigationData`.
7070
## Building the Sample Aircraft (MSFS2020)
7171

7272
> [!NOTE]
73-
> This project is only meant to be tested in MSFS2020. We will add an example for MSFS2024 in the future.
73+
> This project is meant to work in MSFS2020 and MSFS2024.
7474
7575
> [!IMPORTANT]
7676
> 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.
7777
78-
1. Download and install [Bun](https://bun.sh/docs/installation)
79-
2. Open this repository in a terminal
80-
3. Run `bun i` the first time you build, in order to install dependencies
81-
4. Change directory to [`example/gauge`](example/gauge/) using `cd example/gauge`
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).
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
84-
7. Open the `example/aircraft/NavigationDataInterfaceAircraftProject.xml` file in the simulator and build there
78+
> [!IMPORTANT]
79+
> Create a `.env` file in the root of this repository, containing a `SENTRY_URL` variable. Provide your own DSN, or leave it empty.
80+
81+
1. Download and install [Bun](https://bun.sh/docs/installation).
82+
2. Open this repository in a terminal.
83+
3. Run `bun i` the first time you build, in order to install dependencies.
84+
5. Run `bun run build:example`. This command will [build](#building-the-wasm-module-yourself) the wasm module, [build](#building-the-gauge-yourself) the gauge and [copy](#building-the-wasm-module-yourself) the module to the aircraft `panel` folder.
85+
7. Open the `example/aircraft/NavigationDataInterfaceAircraftProject.xml` file in the simulator and build the package.
8586

8687
## Building the WASM Module Yourself
8788

88-
1. Create a `.env` file in the root of this repository, containing a `SENTRY_URL` variable. Provide your own DSN, or leave it empty.
89-
2. Run `bun run build` at the root of the repository (requires Docker)
89+
> [!IMPORTANT]
90+
> Create a `.env` file in the root of this repository, containing a `SENTRY_URL` variable. Provide your own DSN, or leave it empty.
91+
92+
1. Run `bun run build:wasm` at the root of the repository (requires Docker)
9093
- This will take a while to download and build the first time, but subsequent runs will be quicker.
9194
- The WASM module will be compatible for MSFS 2020 & 2024.
92-
3. The WASM module that is compiled in `dist/wasm/2020` folder will be copied automatically to the aircraft `panel` folder.
95+
2. Run `bun run copy:wasm` command to copy the wasm module or do it manually by copying the wasm module in the aircraft `panel` folder.
96+
97+
## Building the Gauge Yourself
98+
99+
> [!IMPORTANT]
100+
> 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.
101+
102+
1. Change directory to [`example/gauge`](example/gauge/) using `cd example/gauge`
103+
2. 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).
93104

94105
## Interfacing with the gauge manually
95106

0 commit comments

Comments
 (0)