Skip to content

Commit

Permalink
chore: update example readme
Browse files Browse the repository at this point in the history
  • Loading branch information
hoffstadt authored May 29, 2024
1 parent 6073063 commit fd8d2a0
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ cd ../out
pilot_light.exe -a example_0
```
### MacOS & Linux
Example for running example 0:
Example for running example 2:
```bash
cd pilotlight/scripts
python3 gen_examples.py
Expand All @@ -26,13 +26,14 @@ chmod +x build.sh
./build.sh

cd ../out
pilot_light -a example_0
pilot_light -a example_2
```

## Example 0 - Minimal App (example_0.c)
Demonstrates the bare minimumal app. This app loads, runs 50 iterations of the update function (printing to console), then exits.
Demonstrates the bare minimum app. This app loads, runs 50 iterations of the update function (printing to console), then exits. Note: this app is not really meant to run. It is for reference.

## Example 1 - API Loading (example_1.c)
Note: this app is not really meant to run. It is for reference.
Demonstrates:
* loading APIs
* hot reloading
Expand Down Expand Up @@ -95,4 +96,4 @@ Demonstrates:
* hot reloading
* loading extensions
* minimal use of graphics extension
* drawing extension (3D)
* drawing extension (3D)

0 comments on commit fd8d2a0

Please sign in to comment.