Skip to content

Commit dfb4bc4

Browse files
committed
Update README.md with some more GIFs
1 parent 37f12f2 commit dfb4bc4

File tree

1 file changed

+7
-18
lines changed

1 file changed

+7
-18
lines changed

README.md

Lines changed: 7 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -147,8 +147,6 @@ To override the value of `workspace` root inside a Git repo:
147147

148148
Enabling of `verilog-ext-mode` minor-mode creates the following keybindings:
149149

150-
<!-- TODO: Add binding for workspace-compile -->
151-
152150
* Features:
153151
* <kbd>M-i</kbd> `verilog-ext-imenu-list`
154152
* <kbd>C-c C-l</kbd> `verilog-ext-code-format`
@@ -212,7 +210,7 @@ For configuration information, see the [wiki](https://github.com/gmlarumbe/veril
212210

213211
`verilog-ext` provides a builtin `xref` backend to navigate definitions and references of the [workspace](#workspace).
214212

215-
<!-- TODO: Insert image -->
213+
<img src="https://github.com/gmlarumbe/verilog-ext/assets/51021955/d196a676-6d28-4bfa-9cee-2662d592b3fb" width=400 height=300>
216214

217215
For configuration information, see the [wiki](https://github.com/gmlarumbe/verilog-ext/wiki/Xref).
218216

@@ -221,20 +219,17 @@ For configuration information, see the [wiki](https://github.com/gmlarumbe/veril
221219

222220
Complete with tags from current [workspace](#workspace). Supports dot and scope completion for module signals, class attributes and methods.
223221

224-
<!-- TODO: Insert image -->
222+
<img src="https://github.com/gmlarumbe/verilog-ext/assets/51021955/7e0e6e49-8d5d-4be0-bb61-290c950e8623" width=400 height=300>
225223

226224
For configuration information, see the [wiki](https://github.com/gmlarumbe/verilog-ext/wiki/Completion).
227225

228226

229227
## Hierarchy extraction ##
230228

231-
<!-- TODO: Update with the builtin and the outshine/hierarchy.el-->
232-
233-
<img src="https://user-images.githubusercontent.com/51021955/209574234-eda2d151-87b4-44db-8edd-e41e2e1b79d4.gif" width=400 height=300>
229+
<img src="https://github.com/gmlarumbe/verilog-ext/assets/51021955/94e009c3-e61c-496a-bacf-02e7d022157a" width=400 height=300>
234230

235231
Hierarchy extraction of module at current buffer.
236232

237-
<!-- TODO: Update this entry -->
238233
For configuration information, see the [wiki](https://github.com/gmlarumbe/verilog-ext/wiki/Hierarchy).
239234

240235

@@ -248,7 +243,6 @@ Auto-configure various SystemVerilog language servers for `lsp-mode` and `eglot`
248243
- [svls](https://github.com/dalance/svls)
249244
- [veridian](https://github.com/vivekmalneedi/veridian)
250245

251-
<!-- TODO: Check instructions, talk about the verilog-ext-feature-list -->
252246
For configuration instructions, see the [wiki](https://github.com/gmlarumbe/verilog-ext/wiki/Language-Server-Protocol)
253247

254248
## Linting ##
@@ -329,14 +323,13 @@ See configuration in the [wiki](https://github.com/gmlarumbe/verilog-ext/wiki/Co
329323
Provides functions to perform compilations with syntax highlighting
330324
and jump to error, buffer preprocessing and makefile development:
331325

332-
- `verilog-ext-workspace-compile`: <kbd>C-c <f5></kbd>
326+
<img src="https://github.com/gmlarumbe/verilog-ext/assets/51021955/1a78cc1b-da3e-4219-baaf-cb1fb11d335c" width=400 height=300>
327+
328+
- `verilog-ext-workspace-compile`: <kbd>C-c \<f5\></kbd>
333329
- `verilog-ext-preprocess`: <kbd>C-c C-p</kbd>
334330
- `verilog-ext-workspace-makefile-create`
335331
- `verilog-ext-workspace-makefile-compile`
336332

337-
<!-- TODO: Add recording -->
338-
<!-- TODO: Add wiki page -->
339-
340333
See configuration in the [wiki](https://github.com/gmlarumbe/verilog-ext/wiki/Compilation).
341334

342335

@@ -374,16 +367,14 @@ Enhanced `which-func` support: show current block/instance at point in the mode-
374367
Add support for syntax-higlighting and alignment via
375368
`verilog-pretty-declarations` of user defined types and classes.
376369

377-
<!-- TODO: Add screenshot -->
370+
<img src="https://github.com/gmlarumbe/verilog-ext/assets/51021955/5e654ba5-6eaa-4699-865c-628cadeda75a" width=400 height=300>
378371

379372
For configuration see [wiki](https://github.com/gmlarumbe/verilog-ext/wiki/Typedefs)
380373

381374
## Time-stamp ##
382375

383376
Automatic update of header timestamp after file saving.
384377

385-
<!-- TODO: Beautify this a bit -->
386-
387378
- `verilog-ext-time-stamp-mode`
388379

389380
For configuration see [wiki](https://github.com/gmlarumbe/verilog-ext/wiki/Time-stamp)
@@ -400,8 +391,6 @@ Auto convert block comments to names after file saving.
400391

401392
Setup `company` to complete with SystemVerilog keywords
402393

403-
<!-- TODO: Basic information -->
404-
405394

406395
## Port connections ##
407396

0 commit comments

Comments
 (0)