Skip to content

Revise README for clarity and updated links #3429

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
beastoin merged 1 commit into from
Nov 14, 2025
Merged

Revise README for clarity and updated links #3429

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 6 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,6 @@ cd omi/app
bash setup.sh ios # android, macos
```

That's it!

**Full setup guide:** [App Setup](https://docs.omi.me/doc/developer/AppSetup) • [Backend Setup](https://docs.omi.me/doc/developer/backend/Backend_Setup)

## Create your own App (1 min)

Download omi App
Expand All @@ -68,15 +64,14 @@ In omi App:

Start speaking, you'll see Real-time transcript on [webhook.site ](https://webhook.site).

To build your own app, replace the webhook URL with your backend. See the **[App Development Guide](https://docs.omi.me/doc/developer/apps/Introduction)** to learn more.

## In this repo:

- [omi device](https://github.com/BasedHardware/omi/tree/main/omi)
- [omi glass](https://github.com/BasedHardware/omi/tree/main/omiGlass)
- [omi app](https://github.com/BasedHardware/omi/tree/main/app)
- [ai personas (web)](https://github.com/BasedHardware/omi/tree/main/personas-open-source)
- [SDKs](sdks)
- [omi device](omi) *nrf\* chips, zephyr (c/c++)*
- [omi glass](omiglass) *esp32-s3, c/c++*
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot Nov 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

The link to omi glass is broken due to incorrect casing. The directory is named omiGlass, but the link points to omiglass. This will not work on case-sensitive file systems like the one GitHub uses. Please correct the link to match the directory name.

Suggested change
- [omi glass](omiglass) *esp32-s3, c/c++*
- [omi glass](omiGlass) *esp32-s3, c/c++*

- [omi app](app) *flutter*
- [omi backend](backend) *python (fastapi, firebase, pinecone, deepgram, openai, silero vad)*
- [SDKs](sdks) *react native, swift, python*
- [ai personas (web)](web/personas-open-source) *nextjs*

## Documentation:

Expand Down