thePR0M3TH3AN/VoxVera
1
0
Fork 0
mirror of https://github.com/PR0M3TH3AN/VoxVera.git synced 2025-09-07 14:38:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update installation instructions

Browse Source
This commit is contained in:
thePR0M3TH3AN
2025-06-21 13:36:06 -04:00
parent ae6d3c7278
commit 883b0d983b
2 changed files with 9 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -22,21 +22,22 @@ dependencies such as Node.js, `javascript-obfuscator`, `html-minifier-terser`,
and the Python packages `InquirerPy` and `rich` if they are not already
available.
If you already have the prerequisites you can install the package directly from
PyPI:
If you already have the prerequisites you can install the package directly. The
project is not currently published on PyPI, so install it from the repository:
```bash
pipx install voxvera # recommended
# or
pip install --user voxvera
pipx install git+https://github.com/PR0M3TH3AN/VoxVera.git # recommended
# or from the current directory
pip install .
```
If your system reports an "externally-managed" Python environment and blocks installation, create a virtual environment first:
If your system reports an "externally-managed" Python environment and blocks
installation, create a virtual environment first:
```bash
python3 -m venv voxvera-venv
source voxvera-venv/bin/activate
pip install voxvera
pip install git+https://github.com/PR0M3TH3AN/VoxVera.git
```
The legacy `src/create_flyer.sh` script remains for backward compatibility. It

2
docs/troubleshooting.md
View File

@@ -17,7 +17,7 @@ This page collects common issues encountered when hosting or accessing flyers.
If problems persist, consult the OnionShare and Tor documentation for more advanced configuration tips.
## Electron GUI
If `npm start` fails with `spawn voxvera ENOENT`, the `voxvera` command is not in your `PATH`. Install it with `pipx install voxvera` or run `./install.sh` from the repository.
If `npm start` fails with `spawn voxvera ENOENT`, the `voxvera` command is not in your `PATH`. Install it with `pipx install git+https://github.com/PR0M3TH3AN/VoxVera.git` or run `./install.sh` from the repository.
## Missing dependencies
Run `voxvera check` to see which required tools are present. The command verifies