Skip to content

Commit 7aae01f

Browse files
committed
Update messages for the massive blunder
1 parent 32ac144 commit 7aae01f

File tree

4 files changed

+44
-2
lines changed

4 files changed

+44
-2
lines changed

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ when coding python 3 by voice. It ships with an integrated [Caster](https://git
2929

3030
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/).
3131

32+
CRITICAL UPDATE: My sincerest apologies but up to release 0.1.1 a subtle yet critical installation step was not documented, which may have prevented you from using the plug-in altogether! You can find more information [here](https://github.com/mpourmpoulis/PythonVoiceCodingPlugin/issues/15) but release 0.1.2 should make that installation step redundant for most users, so simply upgrading and [replacing the grammar files](https://github.com/mpourmpoulis/PythonVoiceCodingPlugin/issues/14) should be enough without any further action on your part! Many thanks to LexiconCode for pointing this out!
33+
3234
![](doc/gif/big37.gif)
3335

3436

@@ -47,6 +49,7 @@ In case you have never heard about voice programming before, you should definite
4749
- [Note for those who installed between 0.0.4 and 0.0.5](#note-for-those-who-installed-between-004-and-005)
4850
- [Git Install](#git-install)
4951
- [Install Grammar](#install-grammar)
52+
- [Subl Path](#subl-path)
5053
- [Support for voice coding framework](#support-for-voice-coding-framework)
5154
- [License](#license)
5255
- [Dependencies](#dependencies)
@@ -121,7 +124,7 @@ Needless to say, while coding PythonVoiceCodingPlugin , PythonVoiceCodingPlugin
121124

122125
The code is available on [github](https://github.com/mpourmpoulis/PythonVoiceCodingPlugin)
123126

124-
The latest release is 0.1.0!
127+
The latest release is 0.1.2!
125128

126129

127130
## Limitations
@@ -232,6 +235,8 @@ python3 -m pip install --target third_party -r requirements.txt
232235

233236
### Install Grammar
234237

238+
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:
239+
235240
- Make sure you have [Caster](https://caster.readthedocs.io/en/latest/) installed
236241

237242
- 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
@@ -250,7 +255,19 @@ in order to make this process easier, under `Preferences > Package Settings > P
250255

251256
![](doc/gif/install2.gif)
252257

258+
### Subl Path
259+
260+
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!
261+
262+
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:
263+
264+
* If `subl` is already in the path, it will use normally
265+
266+
* 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!
267+
268+
if sublime is installed in another directory, you must unfortunately add it to the path yourself!
253269

270+
Please note that this does not affect Linux!
254271

255272

256273
## Support for voice coding framework

messages.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{
22
"0.1.0": "messages/0.1.0.txt",
33
"0.1.1": "messages/0.1.1.txt",
4+
"0.1.2": "messages/0.1.2.txt",
45
"install": "messages/install.txt"
56
}

messages/0.1.2.txt

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
=====================
2+
CRITICAL UPDATE
3+
=====================
4+
5+
My sincerest apologies but up to release 0.1.1 a subtle yet critical installation step was not documented, which may have prevented you from using the plug-in altogether!
6+
7+
You can find more information at https://github.com/mpourmpoulis/PythonVoiceCodingPlugin/issues/15 but release 0.1.2 should make that installation step redundant for most users, so SIMPLY UPGRADING and replacing the grammar files should be enough without any further action on your part!
8+
9+
In order to rapidly upgrade your grammars, if you are using Caster 1.x.x under
10+
11+
Preferences > Package Settings > PythonVoiceCodingPlugin
12+
13+
You will find
14+
15+
Quick 1.0.0 Install
16+
17+
More information https://github.com/mpourmpoulis/PythonVoiceCodingPlugin/issues/14
18+
19+
Many thanks to LexiconCode for pointing this massive blunder out and once again I am deeply sorry!

messages/install.txt

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,15 @@ This link along with links to the online documentation containing around 100 gi
88

99
Preferences > Package Settings > PythonVoiceCodingPlugin
1010

11-
From there you can also retrieve the Caster grammars that are necessary for using the plug-in along with instructions on how to install them. It supports all version of Caster 0.5, 0.6, 1.x but please upgrade as support for older versions will soon be dropped! As a note if you're using any version above 1.0.0 you must also enable it by saying
11+
From there you can also retrieve the Caster grammars that are necessary for using the plug-in along with instructions on how to install them as well as a
12+
13+
Quick 1.0.0 Install
14+
15+
utility. It supports all version of Caster 0.5, 0.6, 1.x but please upgrade as support for older versions will soon be dropped! As a note if you're using any version above 1.0.0 you must also enable it by saying
1216

1317
enable python voice coding plugin
1418

19+
1520
Finally you should be aware that there are some experimental/unofficial features you can manually enable!
1621

1722

0 commit comments

Comments
 (0)