Browse Source

Update Windows installation guide with virtual environment support

Changes:
- Add virtual environment setup as recommended installation method
- Keep legacy global installation options for experienced users
- Add Python version requirements (3.8+)
- Provide clear guidance on which installation method to choose
- Update running instructions for both virtual env and global installs
- Cross-reference README_VENV.md for detailed virtual environment docs

The guide now recommends the automated virtual environment setup while
preserving the original Windows-specific installer for users who prefer
global installation or need fallback options.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
master
melancholytron 2 months ago
parent
commit
294be456e2
  1. 66
      INSTALL_WINDOWS.md

66
INSTALL_WINDOWS.md

@ -1,8 +1,39 @@
# Windows Installation Guide
## Quick Installation
## Requirements
If you're getting errors with the regular installation, use this Windows-specific installer:
- **Python 3.8 or newer** (check with `python --version`)
- Windows 10 or newer (older versions may work but aren't tested)
## Recommended: Virtual Environment Setup (New!)
**Best option for most users - completely isolated and automated:**
```bash
# Download/clone the project, then run:
python setup_venv.py
# Run the application:
run_in_venv.bat
# Or manually activate and run:
activate.bat
python run.py
```
The virtual environment setup will:
- Create an isolated Python environment
- Install all dependencies automatically
- Handle MIDI library issues gracefully
- Create convenient activation scripts
- Work in simulator mode if MIDI fails
See [README_VENV.md](README_VENV.md) for detailed virtual environment documentation.
## Legacy Installation Options
### Quick Installation (Global Environment)
If you prefer global installation or the virtual environment setup doesn't work, use this Windows-specific installer:
```bash
python install_windows.py
@ -89,7 +120,21 @@ except Exception as e:
## Running the Application
Once installed, run:
### Virtual Environment (Recommended)
```bash
# Option 1: Direct run (easiest)
run_in_venv.bat
# Option 2: Manual activation
activate.bat
python run.py
# Option 3: PowerShell users
.\activate.ps1
python run.py
```
### Global Installation
```bash
python run.py
```
@ -100,4 +145,17 @@ The application will start in simulator mode by default, which works without any
- All arpeggiator functionality
- Complete GUI interface
For hardware MIDI, select "Hardware Mode" in the Output Controls tab.
For hardware MIDI, select "Hardware Mode" in the Output Controls tab.
## Which Installation Method Should I Use?
**Use Virtual Environment if:**
- You're new to Python or want the easiest setup
- You want to avoid conflicts with other Python projects
- You want the most reliable installation experience
- You plan to develop or modify the code
**Use Global Installation if:**
- You prefer installing packages system-wide
- You're experienced with Python dependency management
- You're already managing your Python environment manually
Loading…
Cancel
Save