Skip to content

Commit 2f93790

Browse files
committed
add the example repo link to the docs
1 parent edb3bc9 commit 2f93790

File tree

3 files changed

+7
-2
lines changed

3 files changed

+7
-2
lines changed

augmentos_docs/docs/getting-started.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -234,4 +234,5 @@ Congratulations! You've built your first AugmentOS app. To continue your journey
234234
### Get Help
235235
- Join our [Discord community](https://discord.gg/5ukNvkEAqT) for support
236236
- Visit [AugmentOS.org](https://augmentos.org) for the latest updates
237-
- Check out the [GitHub repository](https://github.com/AugmentOS-Community/AugmentOS) for examples
237+
- Check out the [GitHub repository](https://github.com/AugmentOS-Community/AugmentOS) for examples
238+
- For a more in-depth example with app settings support, see the [Live-Captions repository](https://github.com/AugmentOS-Community/LiveCaptionsOnSmartGlasses)

augmentos_docs/docs/index.md

+2
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@ Developers can deploy finished apps to the [AugmentOS Store](https://appstore.au
3535

3636
- [AugmentOS Website](https://augmentos.org)
3737
- [GitHub Repo](https://github.com/AugmentOS-Community/AugmentOS)
38+
- [Example App Repo](https://github.com/AugmentOS-Community/AugmentOS-Cloud-Example-App)
39+
- [Live-Captions Repo](https://github.com/AugmentOS-Community/LiveCaptionsOnSmartGlasses) - A more in-depth example with app settings support
3840
- [Discord Community](https://discord.gg/5ukNvkEAqT) - Get help from the team and community
3941

4042
Ready to dive deeper? Follow our [Quickstart guide](quickstart) to build your first app!

augmentos_docs/docs/quickstart.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,8 @@ Download AugmentOS from [AugmentOS.org/install](https://AugmentOS.org/install)
5454
```bash
5555
git clone [email protected]:AugmentOS-Community/AugmentOS-Cloud-Example-App.git
5656
```
57+
58+
**Note:** If you want a more in-depth example (recommended for those who've already completed this quickstart), you can use the [Live-Captions repository](https://github.com/AugmentOS-Community/LiveCaptionsOnSmartGlasses) which includes app settings support.
5759
3. Navigate to the repo directory and install dependencies:
5860
```bash
5961
cd AugmentOS-Cloud-Example-App
@@ -77,7 +79,7 @@ Download AugmentOS from [AugmentOS.org/install](https://AugmentOS.org/install)
7779
```
7880
Note: `3000` is the port. It must match what is in the app config. If you changed it to `8080`, use `8080` for ngrok instead.
7981

80-
For more information, visit the [AugmentOS-Cloud-Example-App repository](https://github.com/AugmentOS-Community/AugmentOS-Cloud-Example-App).
82+
For more information, visit the [AugmentOS-Cloud-Example-App repository](https://github.com/AugmentOS-Community/AugmentOS-Cloud-Example-App). For a more in-depth example with app settings support, see the [Live-Captions repository](https://github.com/AugmentOS-Community/LiveCaptionsOnSmartGlasses).
8183

8284
## Next Steps
8385

0 commit comments

Comments
 (0)