|
| 1 | +# ViewTouch Universal Linux Installer |
| 2 | + |
| 3 | +This creates a single `.run` file that works on **ANY Linux distribution** - just like commercial software installers (NVIDIA, VMware, etc.). |
| 4 | + |
| 5 | +## What It Does |
| 6 | + |
| 7 | +✅ **Universal compatibility** - Works on ANY Linux distro |
| 8 | +✅ **Auto-detects** package manager (apt, dnf, yum, pacman, zypper) |
| 9 | +✅ **Installs dependencies** automatically |
| 10 | +✅ **Builds from source** for optimal performance |
| 11 | +✅ **System-wide installation** to `/usr/viewtouch/` |
| 12 | +✅ **Creates desktop entry** and command-line shortcuts |
| 13 | +✅ **Single file** - easy to distribute |
| 14 | + |
| 15 | +## Supported Linux Distributions |
| 16 | + |
| 17 | +- **Debian-based**: Debian, Ubuntu, Linux Mint, Pop!_OS, Elementary OS |
| 18 | +- **Red Hat-based**: Fedora, RHEL, CentOS, Rocky Linux, AlmaLinux |
| 19 | +- **Arch-based**: Arch Linux, Manjaro, EndeavourOS |
| 20 | +- **SUSE-based**: openSUSE Leap, openSUSE Tumbleweed, SUSE Linux Enterprise |
| 21 | +- **Any Linux** with a supported package manager |
| 22 | + |
| 23 | +## Supported Architectures |
| 24 | + |
| 25 | +- **Intel/AMD x86_64**: Desktop and server systems |
| 26 | +- **ARM64**: Raspberry Pi 4, Pi 5, and compatible single-board computers |
| 27 | + |
| 28 | +## Creating the Installer |
| 29 | + |
| 30 | +Run this script to create the universal installer: |
| 31 | + |
| 32 | +```bash |
| 33 | +cd packaging/installer |
| 34 | +./create-universal-installer.sh |
| 35 | +``` |
| 36 | + |
| 37 | +This creates: `ViewTouch-Universal-Installer.run` |
| 38 | + |
| 39 | +## For End Users |
| 40 | + |
| 41 | +### Installation |
| 42 | + |
| 43 | +1. **Download** the `ViewTouch-Universal-Installer.run` file |
| 44 | +2. **Make executable**: `chmod +x ViewTouch-Universal-Installer.run` |
| 45 | +3. **Run as root**: `sudo ./ViewTouch-Universal-Installer.run` |
| 46 | + |
| 47 | +The installer will: |
| 48 | +- Detect your Linux distribution |
| 49 | +- Install build dependencies |
| 50 | +- Build ViewTouch from source |
| 51 | +- Install system-wide |
| 52 | +- Create desktop shortcuts |
| 53 | + |
| 54 | +### Usage After Installation |
| 55 | + |
| 56 | +- **GUI**: Find "ViewTouch POS" in your Applications menu |
| 57 | +- **Terminal**: Run `vtpos` from anywhere |
| 58 | +- **Direct**: `/usr/viewtouch/bin/vtpos` |
| 59 | + |
| 60 | +## Technical Details |
| 61 | + |
| 62 | +The installer is a **self-extracting shell script** that: |
| 63 | + |
| 64 | +1. **Detects distribution** using `/etc/os-release` |
| 65 | +2. **Installs dependencies** using the native package manager |
| 66 | +3. **Extracts source code** embedded in the installer |
| 67 | +4. **Builds with CMake** for the target architecture |
| 68 | +5. **Installs system-wide** with proper permissions |
| 69 | +6. **Creates shortcuts** for easy access |
| 70 | +7. **Cleans up** temporary files |
| 71 | + |
| 72 | +## CI/CD Integration |
| 73 | + |
| 74 | +The installer is automatically built by GitHub Actions: |
| 75 | +- **Workflow**: `.github/workflows/universal-installer.yml` |
| 76 | +- **Trigger**: Manual or git tags (`v*`) |
| 77 | +- **Artifact**: `ViewTouch-Universal-Installer.run` |
| 78 | + |
| 79 | +## File Size |
| 80 | + |
| 81 | +The installer contains the complete ViewTouch source code and is approximately **15MB**. |
0 commit comments