Skip to content

Commit a656024

Browse files
committed
Updating README
1 parent e0cba4a commit a656024

File tree

1 file changed

+27
-7
lines changed

1 file changed

+27
-7
lines changed

README.md

Lines changed: 27 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,24 @@ compilation order, interpreting some compilers messages and providing some
3333
## Installation
3434

3535
```sh
36-
pip install hdl-checker
36+
pip install hdl-checker --upgrade
3737
```
3838

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+
3947
## Editor support
4048

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] |
4554

4655
## Usage
4756

@@ -87,7 +96,7 @@ HDL Checker supports
8796
8897
### Configuring HDL Checker
8998
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.
91100
92101
### LSP server
93102
@@ -101,6 +110,14 @@ hdl_checker --lsp
101110
On a Linux system, log file will be at `/tmp/hdl_checker_log_pid<PID_NUMBER>.log` and
102111
`/tmp/hdl_checker_stderr_pid<PID_NUMBER>.log`.
103112
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+
104121
### HTTP server
105122
106123
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
179196
trademarks mentioned or used by this software.
180197
181198
[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
182201
[docker]: https://www.docker.com/
183202
[GHDL]: https://github.com/ghdl/ghdl
184203
[gpl]: http://www.gnu.org/copyleft/gpl.html
185204
[hdl_checker_container]: https://cloud.docker.com/u/suoto/repository/docker/suoto/hdl_checker_test
186205
[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
187208
[Intel_msim]: https://www.intel.com/content/www/us/en/software/programmable/quartus-prime/model-sim.html
188209
[issue_tracker]: https://github.com/suoto/hdl_checker/issues
189210
[LSP]: https://en.wikipedia.org/wiki/Language_Server_Protocol
190211
[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
192212
[vim-hdl]: https://github.com/suoto/vim-hdl/
193213
[Vivado_Simulator]: https://www.xilinx.com/products/design-tools/vivado/simulator.html
194214
[Xilinx_Vivado]: http://www.xilinx.com/products/design-tools/vivado/vivado-webpack.html

0 commit comments

Comments
 (0)