From edea2d3a6f9d7dc00c0d5c65d4fb8584a61f9365 Mon Sep 17 00:00:00 2001 From: thePR0M3TH3AN <53631862+PR0M3TH3AN@users.noreply.github.com> Date: Fri, 18 Jul 2025 11:45:22 -0400 Subject: [PATCH] docs: expand GUI start options --- README.md | 14 ++++++++------ .../content/01-getting-started/06-gui_adapter.md | 11 +++++------ 2 files changed, 13 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index a72ce57..8e62cbb 100644 --- a/README.md +++ b/README.md @@ -232,15 +232,11 @@ For additional command examples, see [docs/advanced_cli.md](docs/advanced_cli.md ### Getting Started with the GUI SeedPass also ships with a simple BeeWare desktop interface. Launch it from -your virtual environment using: +your virtual environment using any of the following commands: ```bash +seedpass gui python -m seedpass_gui -``` - -If installed globally, you can run the `seedpass-gui` entry point instead: - -```bash seedpass-gui ``` @@ -601,6 +597,12 @@ scripts/vendor_dependencies.sh pyinstaller SeedPass.spec ``` +You can also produce packaged installers for the GUI with BeeWare's Briefcase: + +```bash +briefcase build +``` + The standalone executable will appear in the `dist/` directory. This process works on Windows, macOS and Linux but you must build on each platform for a native binary. ## Security Considerations diff --git a/docs/docs/content/01-getting-started/06-gui_adapter.md b/docs/docs/content/01-getting-started/06-gui_adapter.md index c45aef5..e930307 100644 --- a/docs/docs/content/01-getting-started/06-gui_adapter.md +++ b/docs/docs/content/01-getting-started/06-gui_adapter.md @@ -4,20 +4,19 @@ SeedPass ships with a proof-of-concept graphical interface built using [BeeWare] ## Getting Started with the GUI -After installing the project dependencies, launch the desktop interface with: +After installing the project dependencies, launch the desktop interface with one +of the following commands: ```bash +seedpass gui python -m seedpass_gui -``` - -If you installed the package globally, you can use the provided entry point: - -```bash seedpass-gui ``` The GUI shares the same encrypted vault and configuration as the command line tool. +To generate a packaged binary, run `briefcase build` (after the initial `briefcase create`). + ```mermaid graph TD core["seedpass.core"]