mirror of
https://github.com/PR0M3TH3AN/VoxVera.git
synced 2025-09-07 14:38:42 +00:00
Add Electron GUI and packaging scripts
This commit is contained in:
16
README.md
16
README.md
@@ -17,6 +17,16 @@ See [docs/usage.md](docs/usage.md) for detailed usage instructions.
|
||||
|
||||
Run the installer to set up all dependencies and the `voxvera` CLI in one step.
|
||||
|
||||
### GUI
|
||||
An Electron wrapper is provided under `gui/electron` for users that prefer a graphical interface.
|
||||
Run it with:
|
||||
|
||||
```bash
|
||||
cd gui/electron
|
||||
npm install
|
||||
npm start
|
||||
```
|
||||
|
||||
### Linux/macOS
|
||||
|
||||
```bash
|
||||
@@ -116,5 +126,11 @@ Additional documentation is available in the `src/` directory; see [src/README.m
|
||||
|
||||
Additional documentation, including step-by-step instructions and hosting guides, lives under the [docs](docs/) directory.
|
||||
|
||||
## Packages
|
||||
Prebuilt binaries are published on the releases page. Linux users can run the
|
||||
`packaging/build_appimage.sh` script after a PyInstaller build to create a
|
||||
portable AppImage. Homebrew and Chocolatey formulas are provided under
|
||||
`packaging/` for easy upgrades on macOS and Windows.
|
||||
|
||||
|
||||
This project is licensed under the [MIT License](./LICENSE).
|
||||
|
Reference in New Issue
Block a user