Skip to content

Commit

Permalink
Merge pull request #33 from alikhatibak/documentation
Browse files Browse the repository at this point in the history
Updated README as per Issue #32
  • Loading branch information
psethwick authored Mar 5, 2024
2 parents 5c2ac65 + cbce2c9 commit 918d940
Showing 1 changed file with 15 additions and 4 deletions.
19 changes: 15 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,24 +24,35 @@ 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 <https://plover.readthedocs.io/en/latest/cli_reference.html>`_.

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
=======

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
#####
Expand Down

0 comments on commit 918d940

Please sign in to comment.