From a8256f23e31a8bb8a0dd8908f3db374b9448fe2c Mon Sep 17 00:00:00 2001 From: Rohit Mulani Date: Tue, 23 Jun 2026 11:52:14 +0400 Subject: [PATCH] docs: clarify first-run setup --- README.MD | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.MD b/README.MD index 158ecf0..afe4b30 100644 --- a/README.MD +++ b/README.MD @@ -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 @@ -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. \ No newline at end of file +- **GitHub Community**: For all the open-source contributors who have developed libraries and tools that made this project feasible.