From 883b0d983b475960b4fa792e8382087b72f19c78 Mon Sep 17 00:00:00 2001 From: thePR0M3TH3AN <53631862+PR0M3TH3AN@users.noreply.github.com> Date: Sat, 21 Jun 2025 13:36:06 -0400 Subject: [PATCH] docs: update installation instructions --- README.md | 15 ++++++++------- docs/troubleshooting.md | 2 +- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 32a913d..e371203 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index 1991e34..7d8aaba 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -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