Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated README as per Issue #32 #33

Merged
merged 1 commit into from
Mar 5, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading