|
|
@@ -2,12 +2,10 @@
|
|
2
|
2
|
|
|
3
|
3
|
[VHDL-Tool](https://www.vhdltool.com/) provides a [language server](https://github.com/Microsoft/language-server-protocol) for the VHDL hardware description language. This plugin makes VHDL-Tool's language server interface available from within VSCode.
|
|
4
|
4
|
|
|
5
|
|
-**This is beta quality code. Report bugs here: https://git.vhdltool.com/vhdl-tool/vhdl-tool/issues.
|
|
|
5
|
+This is beta quality code. Report bugs here: https://git.vhdltool.com/vhdl-tool/vhdl-tool/issues.
|
|
6
|
6
|
|
|
7
|
7
|
To use this plugin, you must first [download](https://www.vhdltool.com/download) VHDL-Tool. See the requirements section.
|
|
8
|
8
|
|
|
9
|
|
-For now, only Linux is supported.
|
|
10
|
|
-
|
|
11
|
9
|
## Features
|
|
12
|
10
|
|
|
13
|
11
|
* Syntax checking
|
|
|
@@ -35,17 +33,20 @@ For now, only Linux is supported.
|
|
35
|
33
|
Before using this plugin, you must ensure that the `vhdl-tool` binary is installed on your system. To install `vhdl-tool` and setup your environment, do the following:
|
|
36
|
34
|
|
|
37
|
35
|
1. Install this plugin.
|
|
38
|
|
-2. Download the `vhdl-tool` binary from [here](https://www.vhdltool.com/download), make sure it has execute permissions, and put it somewhere in your $PATH.
|
|
|
36
|
+2. Download `vhdl-tool` from [here](https://www.vhdltool.com/download). If you are using the Linux version, make sure it has execute permissions, and put it somewhere in your $PATH.
|
|
39
|
37
|
3. Create a vhdltool-config.yaml configuration file for your project by following the instructions [here](https://www.vhdltool.com/configuration).
|
|
40
|
38
|
4. Install one of the other VHDL plugins available in the marketplace for syntax highlighting. Search for VHDL in the extensions sidebar. **This step is compulsory as these plugins define the VHDL language and if VSCode does not know about VHDL it cannot launch the language server**.
|
|
41
|
39
|
5. Launch VSCode and open the folder containing the configuration file created in the previous step.
|
|
42
|
40
|
|
|
43
|
41
|
## Known Limitations
|
|
44
|
42
|
* The go to definition and find references commands are not accurate in the presence of overloading. In the case of multiple overloaded identifiers with the same name, the type correct one may not be chosen.
|
|
45
|
|
-* VHDL-2008 is only partially supported.
|
|
46
|
43
|
|
|
47
|
44
|
## Release Notes
|
|
48
|
45
|
|
|
|
46
|
+### 0.0.6
|
|
|
47
|
+
|
|
|
48
|
+Windows support
|
|
|
49
|
+
|
|
49
|
50
|
### 0.0.1
|
|
50
|
51
|
|
|
51
|
52
|
Initial beta release of VHDL-Tool.
|
VHDL Tool