Skip to content

Commit ca2c3d3

Browse files
committed
docs: update old references, include link for clarity
1 parent ff36996 commit ca2c3d3

File tree

2 files changed

+12
-10
lines changed

2 files changed

+12
-10
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,13 @@ Here's an overview on the structure of this repository, which is designed to be
3232

3333
## Building the Sample Aircraft
3434

35-
Before building, make sure you have properly created and set an `.env` file in `src/gauge`! An example can be found in the `.env.example` file in that directory. Replace with your credentials
35+
Before building, make sure you have properly created and set an `.env` file in `examples/gauge`! An example can be found in the `.env.example` file in that directory. Replace with your credentials
3636

3737
1. [Download](https://nodejs.org/en/download) Node.js
38-
2. Open the `src/gauge` folder in a terminal
38+
2. Open the `examples/gauge` folder in a terminal
3939
3. Run `npm i` the first time you build, in order to install dependencies
4040
4. Run `npm run build` to build into the `PackageSources` folder of the aircraft sample (or `npm run dev` to build into the `Packages` folder of the aircraft and listen to changes in the source).
41-
5. Make sure the WASM module is included in the `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
41+
5. Make sure the WASM module is included in the [`panel`](examples/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
4242
6. Open the `examples/aircraft/NavigationDataInterfaceAircraftProject.xml` file in the simulator and build there
4343

4444
## Building the WASM Module Yourself

examples/gauge/README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1-
# Gauge example
2-
3-
This is a simple JavaScript gauge to interface with the WASM module.
4-
5-
## Building
6-
7-
To build to your `Packages` folder and listen to changes (i.e. when you're debugging or quickly prototyping) you can run `npm run dev`. Otherwise, run `npm run build`
1+
# Gauge example
2+
3+
This is a simple JavaScript gauge to interface with the WASM module.
4+
5+
## Building
6+
7+
To build to your `Packages` folder and listen to changes (i.e. when you're debugging or quickly prototyping) you can run `npm run dev`. Otherwise, run `npm run build`
8+
9+
- Note: `npm run dev` will output once into the `PackageSources` folder initially to prevent cases where the `build` command isn't ran before building in the sim which would lead to errors

0 commit comments

Comments
 (0)