Convert to plugin

This commit is contained in:
Stanley Sakai 2018-02-26 17:17:41 -05:00 • committed by Ted Morin
commit 52eece316b
3 changed files with 67 additions and 0 deletions

22
README.rst Normal file
View file

@ -0,0 +1,22 @@
Plover Stenograph USB
=====================
Purpose
-------
Implementation of Stenograph USB protocol for Diamanté and Luminex machines. Based on work by Ted Morin and Keith McCready.
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.