Added more information and images to readme

README.md

@@ -2,13 +2,26 @@
 Linux Voice Activated Macro
 ## Status
 This project is currently a work-in-progress and is minimally functional.
+
+Utilising Pocketsphinx, a lightweight voice to text engine you can specify voice commands for the tool to recognise and actions to perform.
+
+Known bugs and planned additions
+- To save and use changes click Ok on the main GUI then reload.
+- Remember last loaded profile and load on start
+- Log window showing spoken words the V2T recognises with ability to right click and assign voice command and actions to current profile
+- Support for joysticks and gaming devices
 ## Requirements
 - python3
 - PyQt5
 - python3-xlib
+- pocketsphinx
+- swig3.0
 ## Install
 - $ pip3 install PyQt5
 - $ pip3 install python3-xlib
+- $ pip3 install pocketsphinx
+- $ sudo apt-get install swig3.0
+- $ sudo ln -s /usr/bin/swig3.0 /usr/bin/swig
 - $ git clone https://github.com/rose-jinyang/LinVAM.git
 ## Usage
 This script must be run with root privilege because it must hook and simulate input devices such as keyboard, mouse etc.
@@ -16,3 +29,15 @@ This script must be run with root privilege because it must hook and simulate in
 - $ xhost +
 - $ sudo python3 ./main.py
 
+### Profiles
+Multiple profiles are supported.  To create a new profile for a specific task/game click new and the main profile editor window will be displayed
+![Main GUI](https://github.com/aidygus/LinVAM/.img/gui.png)
+### Key combinations
+To assign key combinations first decide which functional key to press by clicking on Ctrl, Alt, Shift or Win to denote left or right key then press the actual command key
+![Main GUI](https://github.com/aidygus/LinVAM/.img/combination.png)
+### Complex commands
+It is possible to add multiple actions to a voice command for complex macros with the ability to add a pause between each action.
+You can also assign mouse movements and system commands if you require (eg opening applications such as calculator, browser etc)
+![Main GUI](https://github.com/aidygus/LinVAM/.img/complex.png)
+### Threshold
+As a rough guide use a value of 10 for each syllable of a word then tweak it down for better accuracy.

command.list

@@ -1,5 +1,37 @@
-go /1e-2/
+victor recall ship /1e-40/
-back /1e-3/
+victor cargo scoop /1e-45/
-left /1e-10/
+victor balance power /1e-40/
-right /1e-3/
+victor power to weapons /1e-45/
-stop /1e-8/
+victor power to engines /1e-55/
+victor power to shields /1e-50/
+recall fighter /1e-40/
+fighter defend me /1e-50/
+fighter attack target /1e-60/
+fighter engage at will /1e-60/
+fighter maintain formation /1e-70/
+fighter hold position /1e-60/
+victor hand brake /1e-30/
+victor headlights /1e-40/
+toggle turret mode /1e-40/
+next fire group /1e-40/
+previous fire group /1e-60/
+switch hud mode /1e-30/
+toggle night vision /1e-40/
+toggle orbital lines /1e-50/
+verity full speed /1e-20/
+approach speed /1e-20/
+full stop /1e-20/
+target next system /1e-50/
+target highest threat /1e-50/
+next hostile target /1e-50/
+previous hostile target /1e-70/
+cycle next target /1e-50/
+cycle previous target /1e-70/
+victor full beams /1e-40/
+target first wingman /1e-45/
+target second wingman /1e-50/
+target third wingman /1e-45/
+select wing target /1e-50/
+target next subsystem /1e-50/
+target previous subsystem /1e-70/
+wingman nav lock /1e-35/