Skip to content

docs: clarify first-run setup #10

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

Open
rohitmulani63-ops wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: clarify first-run setup #10

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
13 changes: 12 additions & 1 deletion README.MD
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,17 @@ python main.py

You will be prompted to configure your microphone settings upon the first run or if you choose to be prompted every time by the configuration settings.

### First run checklist
If BonziAssist does not start after installation, check these items first:

1. Run commands from the repository root, the same folder that contains `main.py` and `mic_config.json`.
2. Copy `helpers\.env.example` to `helpers\.env`, then fill in the required values in that new file.
3. Install the dependencies with `pip install -r requirements.txt`.
4. Start the app with `python main.py`.
5. When the microphone prompt appears, select the input device you want BonziAssist to listen through.

The microphone choice is saved in `mic_config.json`, so you normally only need to configure it once. If the wrong microphone was selected, delete or edit `mic_config.json` and run `python main.py` again.

## TODO

- [x] **Add LiteLLM**: Enable Bonzi to talk back to you
Expand Down Expand Up @@ -60,4 +71,4 @@ First of all, I appreciate anyone being excited about this project. That being s
- **SimpleAudio**: Used for playing back audio responses generated by the system.
- **PyAudio**: Handles microphone input and audio stream management.
- **Python-dotenv**: For managing environment variables in a .env file, which helps secure API keys and other sensitive settings.
- **GitHub Community**: For all the open-source contributors who have developed libraries and tools that made this project feasible.
- **GitHub Community**: For all the open-source contributors who have developed libraries and tools that made this project feasible.