@@ -33,15 +33,24 @@ compilation order, interpreting some compilers messages and providing some
33
33
## Installation
34
34
35
35
``` sh
36
- pip install hdl-checker
36
+ pip install hdl-checker --upgrade
37
37
```
38
38
39
+ or
40
+
41
+ ``` sh
42
+ pip install hdl-checker --user --upgrade
43
+ ```
44
+
45
+ (Need to add ` $HOME/.local/bin ` to your ` PATH ` environment variable)
46
+
39
47
## Editor support
40
48
41
- | Editor | Info |
42
- | :---: | :--- |
43
- | Vim | Out of the box via [ dense-analysis/ale] [ ALE ] , other LSP clients should work |
44
- | VSCode | [ HDL Checker HDL Checker VSCode client] [ hdl_checker_vscode ] |
49
+ | Editor | Info |
50
+ | :--- | :--- |
51
+ | Vim - [ dense-analysis/ale] [ ALE ] | Soon, see (PR [ #2804 ] [ ALE_PR ] ) |
52
+ | Vim - [ coc.vim] [ coc_vim ] | Will add instructions to the [ Wiki] [ hdl_checker_wiki ] soon |
53
+ | VSCode | [ HDL Checker HDL Checker VSCode client] [ hdl_checker_vscode ] |
45
54
46
55
## Usage
47
56
@@ -87,7 +96,7 @@ HDL Checker supports
87
96
88
97
# ## Configuring HDL Checker
89
98
90
- See the [Setting up a new project][Setting-up-a-project ] section on the wiki.
99
+ See the [Setting up a new project][hdl_checker_wiki_setup ] section on the wiki.
91
100
92
101
# ## LSP server
93
102
@@ -101,6 +110,14 @@ hdl_checker --lsp
101
110
On a Linux system, log file will be at ` /tmp/hdl_checker_log_pid< PID_NUMBER> .log` and
102
111
` /tmp/hdl_checker_stderr_pid< PID_NUMBER> .log` .
103
112
113
+ As a language server, HDL Checker will provide
114
+
115
+ * Diagnostics
116
+ * Hover information
117
+ * Dependencies: will report which path and library have been assigned
118
+ * Design units: will report the compilation sequence and libraries
119
+ * Go to definition of dependencies
120
+
104
121
# ## HTTP server
105
122
106
123
HDL Checker can be used in HTTP server mode also:
@@ -179,16 +196,19 @@ HDL Checker's author has no connection or affiliation to any of the
179
196
trademarks mentioned or used by this software.
180
197
181
198
[ALE]: https://github.com/dense-analysis/ale
199
+ [ALE_PR]: https://github.com/dense-analysis/ale/pull/2804
200
+ [coc_vim]: https://github.com/neoclide/coc.nvim
182
201
[docker]: https://www.docker.com/
183
202
[GHDL]: https://github.com/ghdl/ghdl
184
203
[gpl]: http://www.gnu.org/copyleft/gpl.html
185
204
[hdl_checker_container]: https://cloud.docker.com/u/suoto/repository/docker/suoto/hdl_checker_test
186
205
[hdl_checker_vscode]: https://marketplace.visualstudio.com/items? itemName=suoto.hdl-checker-client
206
+ [hdl_checker_wiki]: https://github.com/suoto/hdl_checker/wiki
207
+ [hdl_checker_wiki_setup]: https://github.com/suoto/hdl_checker/wiki/Setting-up-a-project
187
208
[Intel_msim]: https://www.intel.com/content/www/us/en/software/programmable/quartus-prime/model-sim.html
188
209
[issue_tracker]: https://github.com/suoto/hdl_checker/issues
189
210
[LSP]: https://en.wikipedia.org/wiki/Language_Server_Protocol
190
211
[Mentor_msim]: http://www.mentor.com/products/fv/modelsim/
191
- [Setting-up-a-project]: https://github.com/suoto/hdl_checker/wiki/Setting-up-a-project
192
212
[vim-hdl]: https://github.com/suoto/vim-hdl/
193
213
[Vivado_Simulator]: https://www.xilinx.com/products/design-tools/vivado/simulator.html
194
214
[Xilinx_Vivado]: http://www.xilinx.com/products/design-tools/vivado/vivado-webpack.html
0 commit comments