From 967b8ef51375b4e9602c6cb702f574d0e7a31247 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E5=AD=94=E4=BB=A4=E6=99=8F=28kongly=29?=
 <kongly@mochasoft.com.cn>
Date: Sun, 28 Jun 2026 23:18:09 +0800
Subject: [PATCH] =?UTF-8?q?[docs]=20*=20=E5=AE=8C=E5=96=84=E9=A6=96?=
 =?UTF-8?q?=E6=AC=A1=E5=90=AF=E5=8A=A8=E8=AF=B4=E6=98=8E=20*=20=E6=8B=86?=
 =?UTF-8?q?=E5=88=86=E5=AE=89=E8=A3=85=E4=BE=9D=E8=B5=96=E5=92=8C=E7=8E=AF?=
 =?UTF-8?q?=E5=A2=83=E5=8F=98=E9=87=8F=E9=85=8D=E7=BD=AE=E6=AD=A5=E9=AA=A4?=
 =?UTF-8?q?=20*=20=E8=A1=A5=E5=85=85=20Windows=20=E4=B8=8E=20macOS/Linux?=
 =?UTF-8?q?=20=E7=9A=84=20env=20=E5=A4=8D=E5=88=B6=E5=91=BD=E4=BB=A4=20*?=
 =?UTF-8?q?=20=E5=A2=9E=E5=8A=A0=E5=B8=B8=E8=A7=81=E5=90=AF=E5=8A=A8?=
 =?UTF-8?q?=E9=97=AE=E9=A2=98=E6=8E=92=E6=9F=A5=E8=AF=B4=E6=98=8E?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.MD | 39 +++++++++++++++++++++++++++++++++++----
 1 file changed, 35 insertions(+), 4 deletions(-)

diff --git a/README.MD b/README.MD
index 158ecf0..0f1ba9e 100644
--- a/README.MD
+++ b/README.MD
@@ -13,9 +13,33 @@ BonziAssist revives the classic BonziBuddy assistant in a modern, voice-activate
 - **Real-Time Interaction**: Communicate in real-time, with responses generated through a lightweight LLM.
 
 ### Installation
-1. Clone this repository.
-2. Ensure you have [Python](https://www.python.org/downloads/) and [Visual CPP Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/). installed, and then run `pip install -r requirements.txt` to install the necessary packages.
-4. Set up your environment variables. Edit the `.env.example` file in `helpers\` and follow the instructions there. `[INSTRUCTIONS='Remove this line of instructions. Fill out the info below. Rename this file, and remove the .example. It should just be ".env" now.']`
+1. Clone this repository and open a terminal in the project folder:
+   ```bash
+   git clone https://github.com/dot-Justin/BonziAssist.git
+   cd BonziAssist
+   ```
+2. Ensure you have [Python](https://www.python.org/downloads/) and [Visual CPP Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/) installed.
+3. Install the Python dependencies:
+   ```bash
+   pip install -r requirements.txt
+   ```
+4. Set up your environment variables by copying the example file:
+
+   Windows PowerShell:
+   ```powershell
+   Copy-Item helpers\.env.example helpers\.env
+   ```
+
+   macOS / Linux:
+   ```bash
+   cp helpers/.env.example helpers/.env
+   ```
+
+5. Open `helpers/.env`, remove the `INSTRUCTIONS=` line, and fill in your API settings:
+   ```env
+   LLM_PROVIDER=groq
+   GROQ_API_KEY=your-api-key-here
+   ```
 
 ### Usage
 To start BonziAssist:
@@ -25,6 +49,13 @@ 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.
 
+If BonziAssist does not start, check these common setup issues:
+
+- `GROQ_API_KEY environment variable not found`: make sure `helpers/.env` exists and contains your real API key.
+- `pyaudio` install errors on Windows: install Visual C++ Build Tools, then rerun `pip install -r requirements.txt`.
+- Microphone problems: delete `mic_config.json` and run `python main.py` again to choose a microphone device.
+- Voice activation problems: say `Bonzi` clearly and wait for the response sound before speaking your command.
+
 ## TODO
 
 - [x] **Add LiteLLM**: Enable Bonzi to talk back to you
@@ -60,4 +91,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.