jyapayne/plover_stenograph_usb
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Simplify readme

Browse source
This commit is contained in:
Ted Morin 2018-02-26 22:31:11 -05:00
commit 4718c00c77
3 changed files with 346 additions and 23 deletions
Download patch file Download diff file Expand all files Collapse all files

20
README.rst
View file

@ -1,22 +1,6 @@
Plover Stenograph USB
=====================
Purpose
-------
Implementation of Stenograph USB protocol for Diamanté and Luminex machines. Based on work by Ted Morin and Keith McCready.
Use Stenograph Diamanté and Luminex machines on Plover. The plugin may not work with other machines. If it does, please let me know.
Files
-----
* system.py - Contains key mappings and orthographic rules.
* stenograph.py - Thread-based monitoring of the Stenograph machine output.
* README.rst - Readme.
* setup.cfg - Python setup info.
Installation
------------
1. Make sure you have the Plover Plugin Manager (https://github.com/benoit-pierre/plover_plugins_manager) installed.
2. Pull down repo (click on "Clone or Download" and select "Download.")
3. Open terminal and navigate to the folder you unzipped the files to.
4. Run command `python3 -m pip install -e .` .
5. Make sure your Stenograph machine is plugged in and write a stroke to start a job.
6. Run Plover and select "Stenograph USB" from the dropdown list.
Special thanks to Keith McCready for his guidance and support.