diff --git a/docs/en/usage.md b/docs/en/usage.md index f477bc5..a59fdc3 100644 --- a/docs/en/usage.md +++ b/docs/en/usage.md @@ -4,31 +4,30 @@ This guide covers common CLI workflows. See `docs/docker.md` for Docker instruct ## Prerequisites -VoxVera is designed to be highly portable and requires minimal system dependencies. +VoxVera is designed to be highly portable. You can run it directly from the source code on any platform with Python installed. -### 1. Standalone Binaries (Recommended) -You can download standalone, zero-dependency binaries for your operating system: -- **Linux:** [voxvera-linux](https://github.com/PR0M3TH3AN/VoxVera/releases/latest/download/voxvera-linux) -- **Windows:** [voxvera-windows.exe](https://github.com/PR0M3TH3AN/VoxVera/releases/latest/download/voxvera-windows.exe) -- **macOS:** [voxvera-macos](https://github.com/PR0M3TH3AN/VoxVera/releases/latest/download/voxvera-macos) - -These binaries include everything needed to run VoxVera (except `onionshare-cli`). - -### 2. One-Line Installer -Alternatively, install via our automated script: +### 1. Automated Install (Recommended) +The easiest way to install VoxVera is using our cross-platform installer script: +**Linux / macOS:** ```bash curl -fsSL https://raw.githubusercontent.com/PR0M3TH3AN/VoxVera/main/install.sh | bash ``` -### 3. Manual Python Install -If you prefer to run from source: - -```bash -pipx install 'voxvera@git+https://github.com/PR0M3TH3AN/VoxVera.git@main' -sudo apt install tor onionshare-cli # Debian/Ubuntu +**Windows (PowerShell):** +```powershell +irm https://raw.githubusercontent.com/PR0M3TH3AN/VoxVera/main/install.ps1 | iex ``` +### 2. Manual Source Install +If you have downloaded the source code ZIP: + +1. **Extract** the ZIP file. +2. **Open a terminal** in the extracted folder. +3. **Run the setup script**: + - **Linux/macOS:** `./setup.sh` + - **Windows:** `.\voxvera-install.sh` (or run `python -m pip install .`) + ## Step-by-Step 1. **Initialize:** Run `voxvera init` and follow the prompts. You will be asked to select your language first. @@ -79,10 +78,10 @@ Features: To ensure VoxVera remains accessible even if central repositories are censored, every flyer acts as a mirror for the tool. -When you host a flyer, the **"Download"** button on the landing page provides a `voxvera-portable.zip` containing: +When you host a flyer, the **"Download Source Code"** button on the landing page provides a `voxvera-source.zip` containing: - The full source code and all supported languages. -- All Python dependencies (pre-vendored). -- Cross-platform Tor binaries. +- Installation and setup scripts for all platforms. +- Complete documentation and templates. This allows anyone who scans your flyer to become a new distributor of the VoxVera tool. diff --git a/docs/he/usage.md b/docs/he/usage.md index 5c7a5c8..0fab819 100644 --- a/docs/he/usage.md +++ b/docs/he/usage.md @@ -4,31 +4,30 @@ This guide covers common CLI workflows. See `docs/docker.md` for Docker instruct ## Prerequisites -VoxVera is designed to be highly portable and requires minimal system dependencies. +VoxVera is designed to be highly portable. You can run it directly from the source code on any platform with Python installed. -### 1. Standalone Binaries (Recommended) -You can download standalone, zero-dependency binaries for your operating system: -- **Linux:** [voxvera-linux](https://github.com/PR0M3TH3AN/VoxVera/releases/latest/download/voxvera-linux) -- **Windows:** [voxvera-windows.exe](https://github.com/PR0M3TH3AN/VoxVera/releases/latest/download/voxvera-windows.exe) -- **macOS:** [voxvera-macos](https://github.com/PR0M3TH3AN/VoxVera/releases/latest/download/voxvera-macos) - -These binaries include everything needed to run VoxVera (except `onionshare-cli`). - -### 2. One-Line Installer -Alternatively, install via our automated script: +### 1. Automated Install (Recommended) +The easiest way to install VoxVera is using our cross-platform installer script: +**Linux / macOS:** ```bash curl -fsSL https://raw.githubusercontent.com/PR0M3TH3AN/VoxVera/main/install.sh | bash ``` -### 3. Manual Python Install -If you prefer to run from source: - -```bash -pipx install 'voxvera@git+https://github.com/PR0M3TH3AN/VoxVera.git@main' -sudo apt install tor onionshare-cli # Debian/Ubuntu +**Windows (PowerShell):** +```powershell +irm https://raw.githubusercontent.com/PR0M3TH3AN/VoxVera/main/install.ps1 | iex ``` +### 2. Manual Source Install +If you have downloaded the source code ZIP: + +1. **Extract** the ZIP file. +2. **Open a terminal** in the extracted folder. +3. **Run the setup script**: + - **Linux/macOS:** `./setup.sh` + - **Windows:** `.\voxvera-install.sh` (or run `python -m pip install .`) + ## Step-by-Step 1. **Initialize:** Run `voxvera init` and follow the prompts. You will be asked to select your language first. @@ -79,10 +78,10 @@ Features: To ensure VoxVera remains accessible even if central repositories are censored, every flyer acts as a mirror for the tool. -When you host a flyer, the **"הורד כלי וקוד מקור"** button on the landing page provides a `voxvera-portable.zip` containing: +When you host a flyer, the **"הורד כלי וקוד מקור"** button on the landing page provides a `voxvera-source.zip` containing: - The full source code and all supported languages. -- All Python dependencies (pre-vendored). -- Cross-platform Tor binaries. +- Installation and setup scripts for all platforms. +- Complete documentation and templates. This allows anyone who scans your flyer to become a new distributor of the VoxVera tool. diff --git a/docs/templates/usage.md b/docs/templates/usage.md index 572483f..5139423 100644 --- a/docs/templates/usage.md +++ b/docs/templates/usage.md @@ -4,31 +4,30 @@ This guide covers common CLI workflows. See `docs/docker.md` for Docker instruct ## Prerequisites -VoxVera is designed to be highly portable and requires minimal system dependencies. +VoxVera is designed to be highly portable. You can run it directly from the source code on any platform with Python installed. -### 1. Standalone Binaries (Recommended) -You can download standalone, zero-dependency binaries for your operating system: -- **Linux:** [voxvera-linux](https://github.com/PR0M3TH3AN/VoxVera/releases/latest/download/voxvera-linux) -- **Windows:** [voxvera-windows.exe](https://github.com/PR0M3TH3AN/VoxVera/releases/latest/download/voxvera-windows.exe) -- **macOS:** [voxvera-macos](https://github.com/PR0M3TH3AN/VoxVera/releases/latest/download/voxvera-macos) - -These binaries include everything needed to run VoxVera (except `onionshare-cli`). - -### 2. One-Line Installer -Alternatively, install via our automated script: +### 1. Automated Install (Recommended) +The easiest way to install VoxVera is using our cross-platform installer script: +**Linux / macOS:** ```bash curl -fsSL https://raw.githubusercontent.com/PR0M3TH3AN/VoxVera/main/install.sh | bash ``` -### 3. Manual Python Install -If you prefer to run from source: - -```bash -pipx install 'voxvera@git+https://github.com/PR0M3TH3AN/VoxVera.git@main' -sudo apt install tor onionshare-cli # Debian/Ubuntu +**Windows (PowerShell):** +```powershell +irm https://raw.githubusercontent.com/PR0M3TH3AN/VoxVera/main/install.ps1 | iex ``` +### 2. Manual Source Install +If you have downloaded the source code ZIP: + +1. **Extract** the ZIP file. +2. **Open a terminal** in the extracted folder. +3. **Run the setup script**: + - **Linux/macOS:** `./setup.sh` + - **Windows:** `.\voxvera-install.sh` (or run `python -m pip install .`) + ## Step-by-Step 1. **Initialize:** Run `voxvera init` and follow the prompts. You will be asked to select your language first. @@ -79,10 +78,10 @@ Features: To ensure VoxVera remains accessible even if central repositories are censored, every flyer acts as a mirror for the tool. -When you host a flyer, the **"{{t('web.download_button')}}"** button on the landing page provides a `voxvera-portable.zip` containing: +When you host a flyer, the **"{{t('web.download_button')}}"** button on the landing page provides a `voxvera-source.zip` containing: - The full source code and all supported languages. -- All Python dependencies (pre-vendored). -- Cross-platform Tor binaries. +- Installation and setup scripts for all platforms. +- Complete documentation and templates. This allows anyone who scans your flyer to become a new distributor of the VoxVera tool. diff --git a/packaging/build_appimage.sh b/packaging/build_appimage.sh index a48f22c..2851f61 100755 --- a/packaging/build_appimage.sh +++ b/packaging/build_appimage.sh @@ -1,21 +1,23 @@ #!/usr/bin/env bash set -e -if [ ! -f dist/voxvera-linux ]; then - echo "Run PyInstaller first" >&2 +# Ensure we are in project root +cd "$(dirname "$0")/.." + +ARCH=$(uname -m) +BINARY="voxvera/resources/bin/voxvera-linux-$ARCH" + +if [ ! -f "$BINARY" ]; then + echo "Binary not found: $BINARY. Run scripts/build_binaries.sh first." >&2 exit 1 fi -APPDIR=dist/AppDir +APPDIR=build/AppDir mkdir -p "$APPDIR/usr/bin" -cp dist/voxvera-linux "$APPDIR/usr/bin/voxvera" +cp "$BINARY" "$APPDIR/usr/bin/voxvera" chmod +x "$APPDIR/usr/bin/voxvera" -mkdir -p "$APPDIR/usr/lib/voxvera/resources" -cp -r voxvera/resources/tor "$APPDIR/usr/lib/voxvera/resources/" -# also bundle Tor for the Electron GUI -mkdir -p gui/electron/voxvera/resources -cp -r voxvera/resources/tor gui/electron/voxvera/resources/ +# Desktop file cat > "$APPDIR/voxvera.desktop" <