Skip to content

Commit 32ac144

Browse files
committed
Update installation instructions part one
1 parent e896689 commit 32ac144

File tree

3 files changed

+46
-14
lines changed

3 files changed

+46
-14
lines changed

README.md

Lines changed: 46 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ In case you have never heard about voice programming before, you should definite
3232
![](doc/gif/big37.gif)
3333

3434

35+
3536
## Contents
3637

3738
<!-- MarkdownTOC autolink="true" -->
@@ -41,9 +42,11 @@ In case you have never heard about voice programming before, you should definite
4142
- [Release and Version](#release-and-version)
4243
- [Limitations](#limitations)
4344
- [Installation](#installation)
44-
- [Package Control](#package-control)
45-
- [note for those who installed between 0.0.4 and 0.0.5](#note-for-those-who-installed-between-004-and-005)
46-
- [Git Install](#git-install)
45+
- [Install the main plugin](#install-the-main-plugin)
46+
- [Package Control](#package-control)
47+
- [Note for those who installed between 0.0.4 and 0.0.5](#note-for-those-who-installed-between-004-and-005)
48+
- [Git Install](#git-install)
49+
- [Install Grammar](#install-grammar)
4750
- [Support for voice coding framework](#support-for-voice-coding-framework)
4851
- [License](#license)
4952
- [Dependencies](#dependencies)
@@ -134,17 +137,25 @@ There are of course certain limitations which I would like to make clear from th
134137

135138
## Installation
136139

137-
In order to install, you must install both the plugging as well as the corresponding [grammar](bundles/README.md).
140+
As this is a two-part system, in order to install, you must
141+
142+
- install the main plugin
143+
144+
- install the corresponding [grammar](bundles/README.md) for the version of caster you are using
145+
146+
- put the `subl` executable which enables the communication of those two into the Windows path(from 0.1.2 and above optionally)
138147

139148

140-
There are currently two installation methods for performing the first task
149+
### Install the main plugin
141150

151+
There are currently two installation (Package Control and git) methods for performing the first task,I highly recommend using Package Control.
142152

143-
### Package Control
144153

145-
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
154+
#### Package Control
146155

147-
- open Command Palette
156+
- Firstly make sure you have Package Control installed. If not, please follow the instructions [here](https://packagecontrol.io/installation)
157+
158+
- open Command Palette(Control+Shift+P)
148159

149160
- execute
150161

@@ -160,7 +171,7 @@ PythonVoiceCodingPlugin
160171

161172

162173

163-
#### note for those who installed between 0.0.4 and 0.0.5
174+
##### Note for those who installed between 0.0.4 and 0.0.5
164175

165176
previously the installation of plug-in included running
166177

@@ -178,6 +189,7 @@ https://github.com/mpourmpoulis/PythonVoiceCodingPlugin
178189
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.
179190

180191
This was only temporary solution and I recommend that you ran
192+
181193
```
182194
Package Control:Remove Repository
183195
```
@@ -194,9 +206,9 @@ For any further installation questions, feel free to ask [here](https://github.c
194206

195207

196208

197-
### Git Install
209+
#### Git Install
198210

199-
Currently you can download the plugin directly from github and place it in sublime package folder
211+
Alternatively you can download the plugin directly from github and place it in sublime package folder
200212

201213
for windows users this should be:
202214

@@ -209,14 +221,34 @@ and on Ubuntu it is :
209221
~/.config/sublime-text-3/Packages/
210222
```
211223

212-
Currently the Master Branch and the releases 0.0.5 ships with its dependencies so the next step is not really necessary.
224+
Currently the Master Branch ships with its dependencies so you're good to go!
225+
226+
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):
213227

214-
To 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):
215228
```bash
216229
python3 -m pip install --target third_party -r requirements.txt
217230
```
218231

219232

233+
### Install Grammar
234+
235+
- Make sure you have [Caster](https://caster.readthedocs.io/en/latest/) installed
236+
237+
- 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
238+
`
239+
240+
- 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`
241+
242+
in order to make this process easier, under `Preferences > Package Settings > PythonVoiceCodingPlugin
243+
` you will find utilities
244+
245+
- To retrieve those grammar files and then manually copy paste them
246+
247+
![](doc/gif/install1.gif)
248+
249+
- or to automatically install them to the appropriate directory if you are using Caster 1.x.x
250+
251+
![](doc/gif/install2.gif)
220252

221253

222254

@@ -338,7 +370,7 @@ also some of the other tools I found useful developing this project
338370

339371
Last but not least many things to
340372

341-
* LexiconCode, for porting the grammar from 0.5 to 0.6 and 1.0 versions of Caster
373+
* LexiconCode, for porting the grammar from 0.5 to 0.6 and 1.0 versions of Caster and pointing out the missing documentation for putting the `subl` utility in the path.
342374

343375
* FichteFoll, for pointing out various errors during package review
344376

doc/gif/install1.gif

346 KB
Loading

doc/gif/install2.gif

311 KB
Loading

0 commit comments

Comments
 (0)