Final bits of documentation

Author: mpourmpoulis

README.md

@@ -26,15 +26,12 @@ when coding python 3 by voice.
 - [Documentation](#documentation)
 - [Motivation](#motivation)
 - [Release and Version](#release-and-version)
-  - [Update 0.0.5](#update-005)
 - [Limitations](#limitations)
 - [Installation](#installation)
   - [Package Control](#package-control)
     - [note for those who installed between 0.0.4 and 0.0.5](#note-for-those-who-installed-between-004-and-005)
   - [Git Install](#git-install)
 - [Support for voice coding framework](#support-for-voice-coding-framework)
-  - [Short version:](#short-version)
-  - [Long version:](#long-version)
 - [License](#license)
 - [Dependencies](#dependencies)
 - [Acknowledgements](#acknowledgements)
@@ -102,7 +99,7 @@ I want to be honest. This is not exactly the best code ever written. It is far f
 * is partly customizable. If you find yourself using certain commands with some given parameters often and want a shorthand smaller command, you can always follow my commented banana example:)
 
 
-![](docgif/op37.gif)
+![](doc/gif/op37.gif)
 
 As I said, far (really far) from perfect but nonetheless an out-of-the-box solution which I hope to be helpful ,especially for beginners to get up to speed , and a step towards the right direction. I hope you enjoy using it as much as I have enjoyed coding it:)
 
@@ -111,15 +108,9 @@ Needless to say, while coding PythonVoiceCodingPlugin , PythonVoiceCodingPlugin
 ## Release and Version 
 
 The code is available on [github](https://github.com/mpourmpoulis/PythonVoiceCodingPlugin)
-along with its initial release (0.0.0)!
 
-### Update 0.0.5
+The latest release  is  0.1.0!
 
-Release 0.0.5 he's out fixing problems of 0.0.4 regarding the installation via package control and adds a useful utilities under Preferences > Package Settings  > PythonVoiceCodingPlugin
-
-Update:  release 0.0.2 is out and with many thanks to @LexiconCode  there are now bundles for Caster 0.6.11! 
-Update:  Due an important error I missed, you might be faced with a situation where the pluggin cannot load and thus no commands are executed. in such a case please upgrade to release 0.0.3 which fixes it. I am sorry for any disconvenience caused!
-Update: release 0.0.4 is out shipping with aenea support.
 
 ## Limitations
 
@@ -142,7 +133,7 @@ There are currently two installation methods for performing the first task
 
 ### Package Control
 
-Release 0.0.5 fixes the errors that prevented 0.0.4 from installing directly from package control. You can now install the package simply by 
+Release 0.0.5 fixed the errors that prevented 0.0.4 from installing directly from package control. You can now install the package simply by 
 
 - open Command Palette
 
@@ -223,11 +214,11 @@ python3 -m pip install --target third_party -r requirements.txt
 
 ## Support for voice coding framework
 
-### Short version:
+
 
 they are available grammars for Caster 0.5.11,0.6.11 as well as >=1.0.0  with many thanks to [LexiconCode](https://github.com/LexiconCode)!
 
-It is my highest recommendation if you are using older versions of Caster that you upgrade to the latest master. Sooner or later the plug-in is going to drop support for those older versions and either way the newer version has a lot of improvements!
+It is my highest recommendation if you are using older versions of Caster that you upgrade to the latest one. Sooner or later the plug-in is going to drop support for those older versions and either way the newer version has a lot of improvements!
 
 Regarding operating system support, the plug-in has been tested both on Windows 10 and  on Ubuntu 16.04 as release 0.0.4 introduced support for [aenea](https://github.com/mpourmpoulis/PythonVoiceCodingPlugin/blob/master/bundles/Aenea/README.md)!
 
@@ -236,61 +227,6 @@ Regarding operating system support, the plug-in has been tested both on Windows
 
 
 
-
-
-### Long version:
-
-Ok this can get a little bit  complicated because there is a variety of operating systems, speech recognition backends, macro systems and toolkits built upon them which may or may not introduce complications. To give you an example lets see a few cases of how Caster with Dragon Naturally Speaking can be used: 
-
-- everything native in Windows 
-
-- in combination with aenea on linux host with windows guest where dragon is running and keystrokes are send to the host via rpc commands 
-
-- linux guest receiving keystrokes from pure dragonfly windows host 
-
-- oh and what about that linux guest receiving aenea rpc from windows host?:)
-
-
-
-To understand why all this may become an issue, we need to take a look at how communication between dragonfly and the plugin works. 
-
-
-Probably by far the most convenient way is via sublime comand line interface. This is the default method used. For example after a command of the form 
-
-```python
-"[smart] [<adjective>] argument <argument_index>"
-```
-like
-
-```
-"first argument 2"
-```
-
-The script invokes the subl cli tool with a command like that:
-
-``` bash
-subl --command python_voice_coding_plugin { "arg" : {
-  "command":"argument",
-  "format":1,
-  "adjective":"first",
-  "argument_index":2,
-  }
-}
-```
-So effectively we trigger the command our plugin provides in its top file and pass information about the type of query we want and the parameters we used as a dict encoded as a json string. 
-
-Of course this does not work across virtual machine barriers:) 
-
-To counter this issue the simplest idea, which involves only keystrokes, is to open with some key command sublime console and using a text command to invoke the PythonVoiceCodingPlugin command from the command line. But 
-from my experience this is often way to slow if there are a lot of parameters to pass and messes up with user-interface, as it opens up the console.
-
-So this is not implemented, even though  it does not need custom rpc.
-
-
-For the time being I have bundles for 0.5.11 release of Caster that work as expected on Windows 10 64bit.
-
-
-
 ## License
 
 All code (grammar bundles and plugin) is licensed under 2-clause BSD License.
@@ -335,6 +271,8 @@ Many thanks to the contributors and maintainers of the following pypi packages:
 
 For specific versions be sure to check the requirements.txt
 
+For their licensees check out the dedicated [file](https://github.com/mpourmpoulis/PythonVoiceCodingPlugin/blob/master/DEPENDENCES_LICENSE.md)
+
 ## Acknowledgements
 
 ### Useful Learning Resources
@@ -362,9 +300,23 @@ Many thanks to all of the developers that have put their time and effort behind
 
 * Natlink
 
-* Dragonfly  and Dragonfly2
+* Dragonfly  and [Dragonfly2](https://github.com/dictation-toolbox/dragonfly)
 
 * Caster
 
 
+also some of the other tools I found useful developing this project
+
+* TabNine 
+
+* Quoda
+
+* Automatic Package Reloader
+
+* MarkdownTOC 
+
+* ScreenToGif 
+
+* Jedi 
+
 

messages/install.txt

@@ -1,12 +1,31 @@
-PythonVoiceCodingPlugin
+Thanks For downloading or upgrading to the latest 0.1.0 version of PythonVoiceCodingPlugin! Release 0.1.0 introduces a variety of new features. Just to name a few
 
-Release 0.0.5 he's out fixing problems of 0.0.4 regarding the installation via package control and adds a useful utilities under Preferences > Package Settings  > PythonVoiceCodingPlugin iincluding links to online documentation issues, grammar bundles and so on.
+1) you can now execute paste/delete/swap operations in a single step instead of 2
+2) partial support for multiple cursors and multiple results
+3) drastic improvements in sub indexing and new dedicated commands!
+4) richer argument and big ROI queries
 
-Code wise it is identical in its core with 0.0.4, which makes it almost 2 months old. However
-I am currently wrapping up the development of 0.1.0. Also you should know that Caster 1.x.x is also supported but  you must enable it by saying
+and much more, including some experimental features you can manually enable! You can find more information in my documentation, links to the online version of which you can find along with other useful utilities under
 
+Preferences > Package Settings  > PythonVoiceCodingPlugin
+
+It supports all version of Caster 0.5, 0.6, 1.x but please upgrade as support for older versions will sooner or later be dropped! as a note if you're using any version above 1.0.0 except for copy pasting the grammar in the appropriate folder you must also enable it by saying
 
 enable python voice coding plugin
 
+if you have any problem or questions regarding installation , whether of the plug-in itself or the grammar necessary to use it please let me know at my issues!
+
+NOTE FOR MAC Installers
+
+Honestly you called me a little bit unprepared,i didn't expect anyone to download on Mac:P 
+
+Firstly the core plug-in has not been tested on Mac, though it is pure Python so probably should work?
+
+Secondly currently the grammar is written to be used with Caster which does not support Mac. Nonetheless you could adapt it to standalone dragonfly or what ever suits your system.
+
+
+If you are using Talon , an alternative you might want to check out is
+
+https://github.com/dwiel/talon_community/blob/master/apps/jetbrains_psi.py
 
- if you have any problem or questions regarding installation , whether of the plug-in itself or the grammar necessary to use it please let me know at my issues!
+though I have not tested it.