docs: update all markdown files for new install flow
- INSTALL.md: Add curl install as recommended, add --no-whisper flag - CONTRIBUTING.md: Fix activation instructions for source installs - README.md: Fix development setup to use venv/bin/activate All docs now reflect: - curl | bash installs Whisper by default - --no-whisper for faster VOSK-only install - Correct venv activation paths
This commit is contained in:
+7
-1
@@ -78,7 +78,13 @@ This will:
|
||||
pip install -e ".[dev]"
|
||||
```
|
||||
|
||||
4. **(Optional) Install pre-commit hooks:**
|
||||
4. **Run the application:**
|
||||
```bash
|
||||
source venv/bin/activate
|
||||
vocalinux --debug
|
||||
```
|
||||
|
||||
5. **(Optional) Install pre-commit hooks:**
|
||||
```bash
|
||||
pre-commit install
|
||||
```
|
||||
|
||||
@@ -156,7 +156,7 @@ cd vocalinux
|
||||
./install.sh --dev
|
||||
|
||||
# Activate environment
|
||||
source activate-vocalinux.sh
|
||||
source venv/bin/activate
|
||||
|
||||
# Run tests
|
||||
pytest
|
||||
|
||||
+21
-7
@@ -4,14 +4,22 @@ This guide provides detailed instructions for installing Vocalinux on Linux syst
|
||||
|
||||
## Quick Start
|
||||
|
||||
### One-liner Installation
|
||||
### One-liner Installation (Recommended)
|
||||
|
||||
```bash
|
||||
curl -fsSL https://raw.githubusercontent.com/jatinkrmalik/vocalinux/main/install.sh | bash
|
||||
```
|
||||
|
||||
That's it! The installer handles everything automatically, including Whisper AI support.
|
||||
|
||||
> ⏱️ **Note**: Installation takes ~5-10 minutes due to Whisper AI dependencies.
|
||||
|
||||
### From Source
|
||||
|
||||
```bash
|
||||
git clone https://github.com/jatinkrmalik/vocalinux.git && cd vocalinux && ./install.sh
|
||||
```
|
||||
|
||||
That's it! The installer handles everything automatically.
|
||||
|
||||
## System Requirements
|
||||
|
||||
| Requirement | Details |
|
||||
@@ -64,7 +72,9 @@ Options:
|
||||
--test Run tests after installation
|
||||
--venv-dir=PATH Specify custom virtual environment directory (default: venv)
|
||||
--skip-models Skip downloading VOSK models during installation
|
||||
--with-whisper Install Whisper AI support (requires more disk space)
|
||||
--with-whisper Install Whisper AI support (default in curl install)
|
||||
--no-whisper Skip Whisper installation (faster, VOSK only)
|
||||
-y, --yes Non-interactive mode (accept defaults)
|
||||
--help Show this help message
|
||||
```
|
||||
|
||||
@@ -82,10 +92,14 @@ Options:
|
||||
After installation:
|
||||
|
||||
```bash
|
||||
# Activate the virtual environment
|
||||
source activate-vocalinux.sh
|
||||
# If installed via curl (and ~/.local/bin is in PATH):
|
||||
vocalinux
|
||||
|
||||
# Run Vocalinux
|
||||
# Or run directly:
|
||||
~/.local/share/vocalinux/venv/bin/vocalinux
|
||||
|
||||
# If installed from source:
|
||||
source venv/bin/activate
|
||||
vocalinux
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user