Skip to content

Commit 341ef27

Browse files
committed
update installation instructions
1 parent 0a439ea commit 341ef27

File tree

1 file changed

+32
-4
lines changed

1 file changed

+32
-4
lines changed

README.md

Lines changed: 32 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,12 +72,40 @@ This plugin is implemented as an [LSP](https://packagecontrol.io/packages/LSP) p
7272

7373
## Install the plugin
7474

75-
Finally, install this package via Package Control using a custom repository
75+
> [!IMPORTANT]
76+
> At the time of this writing, my pull request to include this package in the default package control channel is pending. As a consequence, For the following steps to work, you will have to first manually add this package as a repository for package controll to search for. In order to do this
77+
>
78+
> - Open the command palette `ctrl+shift+p` or `cmd+shift+p`
79+
> - run `Package Control: Add Repository`
80+
> - paste the url of this repository: `https://github.com/PythonVoiceCodingPlugin/LSP-pyvoice`
81+
>
82+
>
83+
84+
> [!WARNING]
85+
> It is important to note that the aforementioned method is going to perform calls to `api.github.com` which is rate limited for non-authenticated requests. In that case, Package Control is going to print error messages in the sublime console (ctrl + `) and skip
86+
> our custom repository, causing `LSP-pyvoice` not to show up in the search results. In that case, you can either
87+
> - wait for the rate limit to reset
88+
> - provide credentials in package control settings `Preferences > Package Settings > Package Control`
89+
> - take the `LSP-pyvoice.sublime-package` file from the [latest release](https://github.com/PythonVoiceCodingPlugin/LSP-pyvoice/releases/) and manually paste it to your installed packages directory. To do that `Preferences > Browse Packages` the file Explorer will open inside `~\AppData\Roaming\Sublime Text 3\Packages`. From there navigate to `~\AppData\Roaming\Sublime Text 3\Installed Packages` and paste the file
90+
> - or you can manually install the package by git cloning this repository to your `Packages` directory
91+
>
92+
> I recommend either of the first two methods.
93+
>
94+
95+
96+
To, install this package via Package Control
7697
- Open the command palette `ctrl+shift+p` or `cmd+shift+p`
77-
- run `Package Control: Add Repository`
78-
- paste the url of this repository: `https://github.com/PythonVoiceCodingPlugin/LSP-pyvoice`
98+
- run `Package Control: Install Package`
99+
- type `LSP-pyvoice` and install it
100+
101+
Navigate to any python file, you should see these in the status
102+
103+
![](https://github.com/PythonVoiceCodingPlugin/assets/main/sublime/status_bar.png)
104+
105+
106+
You may have to restart Sublime Text
107+
79108

80-
Restart Sublime Text and navigate to any python file, you should see these in the sidebar
81109

82110
## Install the grammar
83111

0 commit comments

Comments
 (0)