| """Documentation: Installation Guide""" |
|
|
| # Installation Guide - Burme-Coder-Max |
|
|
| ## Prerequisites |
|
|
| - Python 3.8 or higher |
| - pip package manager |
|
|
| ## Installation Methods |
|
|
| ### Method 1: pip install (Recommended) |
|
|
| ```bash |
| pip install burme-coder-max |
| ``` |
|
|
| ### Method 2: From source |
|
|
| ```bash |
| git clone https://github.com/amkyawdev/burme-coder-max.git |
| cd burme-coder-max |
| pip install -e . |
| ``` |
|
|
| ### Method 3: Development install |
|
|
| ```bash |
| git clone https://github.com/amkyawdev/burme-coder-max.git |
| cd burme-coder-max |
| pip install -e ".[dev]" |
| ``` |
|
|
| ## Verify Installation |
|
|
| ```bash |
| burme-coder --version |
| ``` |
|
|
| Expected output: |
| ``` |
| burme-coder-max 1.0.0 |
| ``` |
|
|
| ## Configuration |
|
|
| 1. Copy `.env.example` to `.env`: |
| ```bash |
| cp .env.example .env |
| ``` |
|
|
| 2. Edit `.env` with your settings: |
| ```bash |
| nano .env |
| ``` |
|
|
| ### Required Environment Variables |
|
|
| | Variable | Description | Required | |
| |----------|-------------|----------| |
| | OPENAI_API_KEY | OpenAI API key for AI responses | Yes | |
| | DATABASE_URL | Database connection string | No | |
| |
| ## Dependencies |
| |
| See `requirements.txt` for full dependency list. |
| |
| Main dependencies: |
| - click >= 8.0.0 |
| - rich >= 13.0.0 |
| - requests >= 2.28.0 |
| - pydantic >= 2.0.0 |
| |
| ## Troubleshooting |
| |
| ### Installation fails |
| - Check Python version: `python --version` |
| - Upgrade pip: `pip install --upgrade pip` |
| - Try in virtual environment |
| |
| ### Module not found |
| - Reinstall: `pip install --force-reinstall burme-coder-max` |
| - Check PATH |
| |
| ### Permission denied |
| - Use `--user` flag: `pip install --user burme-coder-max` |
| - Or use virtual environment |
| |
| ## Uninstall |
| |
| ```bash |
| pip uninstall burme-coder-max |
| ``` |
| |
| ## Next Steps |
| |
| See [usage.md](usage.md) for how to use burme-coder-max. |
| |