From e38cf55aa6e494496777052ad40de1c000a87826 Mon Sep 17 00:00:00 2001 From: mpourmpoulis <35875229+mpourmpoulis@users.noreply.github.com> Date: Thu, 9 Jul 2020 13:18:09 +0300 Subject: [PATCH 1/3] add Installation.md --- README.md | 2 +- doc/Installation.md | 132 ++++++++++++++++++++++++++++++++++++++++++++ mkdocs.yml | 1 + 3 files changed, 134 insertions(+), 1 deletion(-) create mode 100644 doc/Installation.md diff --git a/README.md b/README.md index 0956f6d..ca12b5b 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ ![](https://img.shields.io/github/v/release/mpourmpoulis/PythonVoiceCodingPlugin.svg) PythonVoiceCodingPlugin is a Sublime Text 3 plugin meant to enhance user experience -when coding python 3 by voice. It ships with an integrated [Caster](https://github.com/dictation-toolbox/Caster) grammar bundle containing voice commands that provide you with syntactical navigation capabilities! +when coding python 3 by voice. It ships with an integrated [Caster](https://github.com/dictation-toolbox/Caster) grammar bundle containing voice commands that provide you with syntactical navigation capabilities! The [documentation](https://pythonvoicecodingplugin.readthedocs.io/en/latest/) contains some 100+ examples showcasing those capabilities and for any further questions or help with troubleshooting, please let me know at my gitter [channel](https://gitter.im/PythonVoiceCodingPlugin/community)! In case you have never heard about voice programming before, you should definitely check out [Caster](https://caster.readthedocs.io/en/latest/), [dragonfly](https://dragonfly2.readthedocs.io/en/latest/introduction.html) and [Talon](https://talonvoice.com/). diff --git a/doc/Installation.md b/doc/Installation.md new file mode 100644 index 0000000..03c1ebf --- /dev/null +++ b/doc/Installation.md @@ -0,0 +1,132 @@ +## Installation + +As this is a two-part system, in order to install, you must + +- install the main plugin + +- install the corresponding [grammar](../bundles/README.md) for the version of caster you are using + +- put the `subl` executable which enables the communication of those two into the Windows path(from 0.1.2 and above optionally) + + +### Install the main plugin + +There are currently two installation (Package Control and git) methods for performing the first task,I highly recommend using Package Control. + + +#### Package Control + +- Firstly make sure you have Package Control installed. If not, please follow the instructions [here](https://packagecontrol.io/installation) + +- open Command Palette(Control+Shift+P) + +- execute + +``` +Package Control:Install Package +``` + +And then simply + +``` +PythonVoiceCodingPlugin +``` + + + +##### Note for those who installed between 0.0.4 and 0.0.5 + +previously the installation of plug-in included running + +``` +Package Control:Add Repository +``` + +and then entering a URL to my repository + +``` +https://github.com/mpourmpoulis/PythonVoiceCodingPlugin +``` + + +which enabled you to install directly from a master branch rather than my releases and you should be seing a fake version like v2020.01.05.( and so on ) instead of v0.0.4. + +This was only temporary solution and I recommend that you ran + +``` +Package Control:Remove Repository +``` + +so was only install/upgrade from releasees. + + + + +For the time being be warned, that the plug-in has not been tested with portable versions of sublime! + + +For any further installation questions, feel free to ask [here](https://github.com/mpourmpoulis/PythonVoiceCodingPlugin/issues/5) + + + +#### Git Install + +Alternatively you can download the plugin directly from github and place it in sublime package folder + +for windows users this should be: + +``` +C:\Users\Admin\AppData\Roaming\Sublime Text 3\Packages +``` + +and on Ubuntu it is : +``` +~/.config/sublime-text-3/Packages/ +``` + +Currently the Master Branch ships with its dependencies so you're good to go! + +Just in case something is wrong and you want to manually install dependencies,using your installation of python (this worked for me with 3.7.4 and 3.5.2) run from inside the plug-in folder (PythonVoiceCodingPlugin): + +```bash +python3 -m pip install --target third_party -r requirements.txt +``` + + +### Install Grammar + +Furthermore, in order to use the plug-in, you must also install the grammar! You can find additional information [here](../bundles/Caster/README.md) if you intend to use this on Linux via [Aenea](../bundles/Aenea/README.md) you will need a few extra steps but in a nutshell: + +- Make sure you have [Caster](https://caster.readthedocs.io/en/latest/) installed + +- Copy the grammar files to the appropriate user directory,depending on the version of caster these should be either `C:\Users\%USERNAME%\AppData\Local\caster\rules` or `C:\Users\%USERNAME%\.caster\rules +` + +- Reboot/launch Caster and if you are using 1.0 and above do not forget to enable the rule by saying `enable python voice coding plugin` + +in order to make this process easier, under `Preferences > Package Settings > PythonVoiceCodingPlugin +` you will find utilities + +- To retrieve those grammar files and then manually copy paste them + +![](doc/gif/install1.gif) + +- or to automatically install them to the appropriate directory if you are using Caster 1.x.x + +![](doc/gif/install2.gif) + +### Subl Path + +The communication between the main plugin and the grammar happens via the sublime command line interface through the `subl` executable. Up to and including version 0.1.1, it was expected that this executable is in your Windows path but as pointed out by LexiconCode the corresponding documentation was missing! these was a big blunder on my part and may have prevented you from using the project altogether! + +now you can find more information about how you can add this executable to the Windows path [here](https://stackoverflow.com/questions/9440639/sublime-text-from-command-line), but in order to work around this issue without adding an additional installation step for you, release 0.1.2 implements the following scheme: + +* If `subl` is already in the path, it will use normally + +* Otherwise, it will try to fall back to `C:\Program Files\Sublime Text 3\subl` which is where it should be if you have installed sublime in the classical way! In such a case, no extra steps are needed on your part! + +if sublime is installed in another directory, you must unfortunately add it to the path yourself! + +Please note that this does not affect Linux! + + diff --git a/mkdocs.yml b/mkdocs.yml index db3eab4..2b48638 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -23,3 +23,4 @@ nav: - SubIndexing: SubIndexing.md - Operations: Operations.md - Collections: CollectionQueries.md + - Installation: Installation.md From 07192745a8e073a27fb5188777af567232125c1c Mon Sep 17 00:00:00 2001 From: mpourmpoulis <35875229+mpourmpoulis@users.noreply.github.com> Date: Thu, 9 Jul 2020 13:27:41 +0300 Subject: [PATCH 2/3] Update mkdocs.yml --- mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 2b48638..673995c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -17,7 +17,7 @@ theme: name: readthedocs nav: - - Home: README.md + - User Guide: README.md - Argument queries: SelectArgument.md - Big ROI queries: SelectBigROI.md - SubIndexing: SubIndexing.md From 61edd03463bfbf4f252a544e4f61dd4439f14ca5 Mon Sep 17 00:00:00 2001 From: mpourmpoulis <35875229+mpourmpoulis@users.noreply.github.com> Date: Thu, 9 Jul 2020 13:39:05 +0300 Subject: [PATCH 3/3] Update Installation.md --- doc/Installation.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/Installation.md b/doc/Installation.md index 03c1ebf..c8c9b39 100644 --- a/doc/Installation.md +++ b/doc/Installation.md @@ -109,11 +109,11 @@ in order to make this process easier, under `Preferences > Package Settings > P - To retrieve those grammar files and then manually copy paste them -![](doc/gif/install1.gif) +![](./gif/install1.gif) - or to automatically install them to the appropriate directory if you are using Caster 1.x.x -![](doc/gif/install2.gif) +![](./gif/install2.gif) ### Subl Path