From cbce2c962c087d8a50a9ff3c36c461c4dcc2261c Mon Sep 17 00:00:00 2001 From: Ali Khatib Date: Tue, 5 Mar 2024 04:24:27 -0500 Subject: [PATCH] Updated README as per Issue #32 at https://github.com/psethwick/plover_console_ui/issues/32 --- README.rst | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index f285b0a..a3f058b 100644 --- a/README.rst +++ b/README.rst @@ -24,13 +24,22 @@ Getting Started #. Select ``plover_console_ui`` in the list #. Click install -Or directly install ``plover_console_ui`` into Plover's python environment +Or directly install ``plover_console_ui`` into Plover's python environment using ``plover -s plover_plugins install plover_console_ui`` + +- Note: The plover command is available under slightly different names depending on your OS, relative to your installation directory. + - **Windows**: ``C:\Program Files (x86)\Open Steno Project\Plover 4.0.0\plover_console.exe`` + - **macOS**: ``/Applications/Plover.app/Contents/MacOS/Plover`` + - **Linux**: ``plover.AppImage`` + +For more information on Plover's Command Line Reference, see `The Plover Docs `_. Linux/Mac ========= -Start Plover with the --gui option: -``plover --gui console`` +Start Plover with the -g option: +``plover -g console`` + +If your shell returns ``command not found: plover`` or a similar error, refer to Getting Started to access the ``plover`` command. Windows ======= @@ -38,10 +47,12 @@ Windows Due to some Windows workaround code (in Plover), this plugin does not work well on the packaged Windows build Here's a launcher that works: -``python -m plover --gui console`` +``python -m plover -g console`` Yes, it requires essentially 'run from source'... I'm sorry +If your shell returns ``command not found: plover`` or a similar error, refer to Getting Started to access the ``plover`` command. + ##### Usage #####