|
|
| (One intermediate revision by the same user not shown) |
| Line 1: |
Line 1: |
| '''Table of Contents'''
| | #REDIRECT [[Installation_Guide]] |
| | |
| * [[#install-plover-on-windows|Install Plover on Windows]]
| |
| * [[#install-plover-on-mac|Install Plover on Mac]]
| |
| * [[#install-plover-on-linux|Install Plover on Linux]]
| |
| * [[#troubleshooting|Troubleshooting]]
| |
| * [[#setting-up-my-machine|Setting up my machine]]
| |
| * [[#other-installation-methods|Other installation methods]]
| |
| * [[#for-developers-running-from-source|For developers: running from source]]
| |
| | |
| = Install Plover on Windows =
| |
| | |
| Plover can be installed or ran as a portable ZIP. It may be useful to use the portable ZIP if you are running Plover off of a USB stick or the if the host machine has restricted permissions. For all other use cases, however, the installer method is recommended.
| |
| | |
| == [https://github.com/openstenoproject/plover/releases/download/v4.0.0rc2/plover-4.0.0rc2-win64.setup.exe Download the Windows installer here] ==
| |
| | |
| Run the installer and follow the onscreen instructions. You may need to [https://www.windowscentral.com/how-disable-smartscreen-trusted-app-windows-10 grant permissions for the app to bypass Windows Defender SmartScreen.]
| |
| | |
| === [https://github.com/openstenoproject/plover/releases/download/v4.0.0rc2/plover-4.0.0rc2-win64.zip Download the Windows portable ZIP here] ===
| |
| | |
| Extract the entire folder to the location that you'd like to run Plover from. Inside the folder, run <code>plover.exe</code> to start Plover.
| |
| | |
| | |
| -----
| |
| | |
| = Install Plover on Mac =
| |
| | |
| == [https://github.com/openstenoproject/plover/releases/download/v4.0.0rc2/plover-4.0.0rc2-macosx_10_13_x86_64.dmg Download Plover for Mac here] ==
| |
| | |
| # Open the <code>.dmg</code> file.
| |
| # In the mounted disk, drag the <code>Plover.app</code> to your <code>Applications</code> folder.
| |
| # Open the Applications folder, and [https://support.apple.com/en-ca/guide/mac-help/mh40616/mac follow the guide to launch a program from an unidentified developer.]
| |
| # Open <code>System Preferences > Security & Privacy > Privacy > Accessibility</code>.
| |
| # Click the <code>+</code> Button, and go to your applications and select <code>Plover.app</code>.
| |
| | |
| Plover is set up! You can run Plover like you would any other application.
| |
| | |
| <blockquote>'''Note''': Other "keyboard helper"-type applications (e.g. Karabiner Elements and text expanders) may interfere with Plover.
| |
| </blockquote>
| |
| === If you had previously uninstalled Plover or upgraded your system ===
| |
| | |
| Repeat step 4, and remove Plover from the list. '''Do not just uncheck Plover; you will have to explicitly remove Plover by using the <code>-</code> button'''. Once Plover has been removed, readd <code>Plover.app</code> by repeating step 5.
| |
| | |
| | |
| -----
| |
| | |
| = Install Plover on Linux =
| |
| | |
| Plover is provided as an AppImage. This is the only officially supported method to using Plover on Linux.
| |
| | |
| Please note that '''Plover is not officially supported on systems running Wayland at this moment'''. Many distros use Wayland by default and you will need to switch back to use Plover. Follow a tutorial like [https://helpdesk.psionline.com/hc/en-gb/articles/13470827149332-How-to-perform-the-switch-from-the-Wayland-display-server-to-Xorg-X11-on-Linux-Ubuntu-22-04-LTS this one] to determine if you're running Wayland and how to switch.
| |
| | |
| == [https://github.com/openstenoproject/plover/releases/download/v4.0.0rc2/plover-4.0.0rc2-x86_64.AppImage Download the Plover AppImage here] ==
| |
| | |
| To use it:
| |
| | |
| # Download it
| |
| # [http://discourse.appimage.org/t/how-to-make-an-appimage-executable/80 Make it executable] | |
| # Launch it like a standard executable
| |
| | |
| == Allow Access to Serial Ports ==
| |
| | |
| All hobbyist steno keyboards by default use serial protocols to communicate with Plover. You will have to give your user the right privileges in order for these keyboards to work with Plover. You can do this by adding your user to the relevant group.
| |
| | |
| To find the name of the relevant group, plug in your steno keyboard and open a terminal to run the following command:
| |
| | |
| <pre>stat -c "%G" /dev/ttyACM*</pre>
| |
| You should see <code>dialout</code> or <code>uucp</code> depending on your distro. If the above command results in a "file not found" error, try replacing <code>ACM</code> with <code>USB</code> and verify that your keyboard is connected with a working cable.
| |
| | |
| Once you know the correct group, add your user to it by running the following command:
| |
| | |
| <pre>sudo usermod -aG <group> $USER</pre>
| |
| Replace <code><group></code> with the output of the previous command.
| |
| | |
| '''Once you have added yourself to the right group, restart your computer.'''
| |
| | |
| == Error relating to xcb ==
| |
| | |
| You may run into the following error when trying to run Plover:
| |
| | |
| <blockquote>Could not load the Qt platform plugin "xcb" in "" even though it was found. This application failed to start because noQt platform plugin could be initialized. Reinstalling the application may fix this problem.
| |
| </blockquote>
| |
| Ensure that the following packages are installed:
| |
| | |
| * <code>libxcb</code>
| |
| * <code>xcb-util</code>
| |
| * <code>qt5-qtstyleplugins</code>
| |
| * <code>libxcb-cursor0</code>
| |
| | |
| Note that the names of these packages may differ depending on the distro you are using. If the error still persists, run the following:
| |
| | |
| <pre>./plover-4.0.0rc2-x86_64.AppImage -s plover_plugins install -v 'PyQt5==5.14.2' 'PyQt5-sip==12.7.2'</pre>
| |
| = Setting up my machine =
| |
| | |
| Initially, Plover is set up to use your computer keyboard as a steno machine. If you have a steno machine, you'll need to configure Plover to look for your machine. Please check the [https://github.com/openstenoproject/plover/wiki/Supported-Hardware Supported Hardware page] to find instructions specific to your machine.
| |
| | |
| = Other installation methods =
| |
| | |
| == Other releases ==
| |
| | |
| You can browse various other releases of Plover by scrolling through the [https://github.com/openstenoproject/plover/releases releases page]. To download a release, click on "Assets" and download the applicable file for your operating system.
| |
| | |
| Downloading releases:
| |
| | |
| https://github.com/openstenoproject/plover/assets/52895314/7e886397-e35d-41f9-b23b-2e7d22a658e9
| |
| | |
| == Homebrew Cask ==
| |
| | |
| If you have [https://caskroom.github.io/ '''Homebrew Cask'''] installed on your system, you can run <code>brew install --cask plover</code> at the command-line.
| |
| | |
| == Arch AUR package ==
| |
| | |
| Two AUR packages are provided:
| |
| | |
| # [https://aur.archlinux.org/packages/plover/ plover] for the latest stable release
| |
| # and [https://aur.archlinux.org/packages/plover-git/ plover-git] for the current <code>master</code>
| |
| | |
| Note: the plugins manager is not part of <code>plover-git</code>, and is available as a [https://aur.archlinux.org/packages/plover_plugins_manager/ separate package].
| |
| | |
| == Gentoo git ebuild ==
| |
| | |
| Currently, only a git ebuild for the <code>master</code> branch is provided.
| |
| | |
| [https://framagit.org/3/ebuilds Personal overlay.] (out of date dependencies)
| |
| | |
| == Void Linux package ==
| |
| | |
| Plover is packaged in the Void Linux repositories under the package name <code>plover</code>.
| |
| | |
| Note: the plugins manager has not been packaged yet.
| |
| | |
| = Troubleshooting =
| |
| | |
| If you get stuck, you can:
| |
| | |
| * Check the [https://github.com/openstenoproject/plover/wiki/Troubleshooting:-Common-Issues troubleshooting guide.]
| |
| * Search for your problem in our [https://github.com/openstenoproject/plover/issues issue tracker] and our [https://github.com/openstenoproject/plover/discussions Discussions forum.]
| |
| * If you can't find your particular problem, [https://github.com/openstenoproject/plover/issues/new/choose open a support request] or [https://github.com/openstenoproject/plover/discussions/new start a Discussion.]
| |
| | |
| We also have a [https://discord.gg/0lQde43a6dGmAMp2 Plover Discord Server], the [https://github.com/openstenoproject/plover/wiki/Links-to-the-Steno-Community steno community], and a [https://github.com/openstenoproject/plover/discussions GitHub Discussions forum] if you have a general idea or discussion topic.
| |
| | |
| = For developers: running from source =
| |
| | |
| If you want to build from source (e.g. if you are a developer), follow the guide for your operating system:
| |
| | |
| * [https://github.com/openstenoproject/plover/tree/master/windows <code>plover/windows</code>]
| |
| * [https://github.com/openstenoproject/plover/tree/master/linux <code>plover/linux</code>]
| |
| * [https://github.com/openstenoproject/plover/tree/master/osx <code>plover/osx</code>]
| |
