|
| 1 | +## Installation |
| 2 | + |
| 3 | +As this is a two-part system, in order to install, you must |
| 4 | + |
| 5 | +- install the main plugin |
| 6 | + |
| 7 | +- install the corresponding [grammar](../bundles/README.md) for the version of caster you are using |
| 8 | + |
| 9 | +- put the `subl` executable which enables the communication of those two into the Windows path(from 0.1.2 and above optionally) |
| 10 | + |
| 11 | + |
| 12 | +### Install the main plugin |
| 13 | + |
| 14 | +There are currently two installation (Package Control and git) methods for performing the first task,I highly recommend using Package Control. |
| 15 | + |
| 16 | + |
| 17 | +#### Package Control |
| 18 | + |
| 19 | +- Firstly make sure you have Package Control installed. If not, please follow the instructions [here](https://packagecontrol.io/installation) |
| 20 | + |
| 21 | +- open Command Palette(Control+Shift+P) |
| 22 | + |
| 23 | +- execute |
| 24 | + |
| 25 | +``` |
| 26 | +Package Control:Install Package |
| 27 | +``` |
| 28 | + |
| 29 | +And then simply |
| 30 | + |
| 31 | +``` |
| 32 | +PythonVoiceCodingPlugin |
| 33 | +``` |
| 34 | + |
| 35 | + |
| 36 | + |
| 37 | +##### Note for those who installed between 0.0.4 and 0.0.5 |
| 38 | + |
| 39 | +previously the installation of plug-in included running |
| 40 | + |
| 41 | +``` |
| 42 | +Package Control:Add Repository |
| 43 | +``` |
| 44 | + |
| 45 | +and then entering a URL to my repository |
| 46 | + |
| 47 | +``` |
| 48 | +https://github.com/mpourmpoulis/PythonVoiceCodingPlugin |
| 49 | +``` |
| 50 | + |
| 51 | + |
| 52 | +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. |
| 53 | + |
| 54 | +This was only temporary solution and I recommend that you ran |
| 55 | + |
| 56 | +``` |
| 57 | +Package Control:Remove Repository |
| 58 | +``` |
| 59 | + |
| 60 | +so was only install/upgrade from releasees. |
| 61 | + |
| 62 | + |
| 63 | + |
| 64 | + |
| 65 | +For the time being be warned, that the plug-in has not been tested with portable versions of sublime! |
| 66 | + |
| 67 | + |
| 68 | +For any further installation questions, feel free to ask [here](https://github.com/mpourmpoulis/PythonVoiceCodingPlugin/issues/5) |
| 69 | + |
| 70 | + |
| 71 | + |
| 72 | +#### Git Install |
| 73 | + |
| 74 | +Alternatively you can download the plugin directly from github and place it in sublime package folder |
| 75 | + |
| 76 | +for windows users this should be: |
| 77 | + |
| 78 | +``` |
| 79 | +C:\Users\Admin\AppData\Roaming\Sublime Text 3\Packages |
| 80 | +``` |
| 81 | + |
| 82 | +and on Ubuntu it is : |
| 83 | +``` |
| 84 | +~/.config/sublime-text-3/Packages/ |
| 85 | +``` |
| 86 | + |
| 87 | +Currently the Master Branch ships with its dependencies so you're good to go! |
| 88 | + |
| 89 | +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): |
| 90 | + |
| 91 | +```bash |
| 92 | +python3 -m pip install --target third_party -r requirements.txt |
| 93 | +``` |
| 94 | + |
| 95 | + |
| 96 | +### Install Grammar |
| 97 | + |
| 98 | +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: |
| 99 | + |
| 100 | +- Make sure you have [Caster](https://caster.readthedocs.io/en/latest/) installed |
| 101 | + |
| 102 | +- 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 |
| 103 | +` |
| 104 | + |
| 105 | +- 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` |
| 106 | + |
| 107 | +in order to make this process easier, under `Preferences > Package Settings > PythonVoiceCodingPlugin |
| 108 | +` you will find utilities |
| 109 | + |
| 110 | +- To retrieve those grammar files and then manually copy paste them |
| 111 | + |
| 112 | + |
| 113 | + |
| 114 | +- or to automatically install them to the appropriate directory if you are using Caster 1.x.x |
| 115 | + |
| 116 | + |
| 117 | + |
| 118 | +### Subl Path |
| 119 | + |
| 120 | +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! |
| 121 | + |
| 122 | +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: |
| 123 | + |
| 124 | +* If `subl` is already in the path, it will use normally |
| 125 | + |
| 126 | +* 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! |
| 127 | + |
| 128 | +if sublime is installed in another directory, you must unfortunately add it to the path yourself! |
| 129 | + |
| 130 | +Please note that this does not affect Linux! |
| 131 | + |
| 132 | + |
0 commit comments