Skip to content

Commit

Permalink
WIP: More updates on README
Browse files Browse the repository at this point in the history
  • Loading branch information
gmlarumbe committed Aug 21, 2023
1 parent 51f6eb4 commit f30cb5e
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ If installed and loaded via `use-package`:
:config
(verilog-ext-mode-setup))
;; To use `verilog-ts-mode' as the default major-mode also add the line below:
;; To use `verilog-ts-mode' as the default major-mode also add the lines below:
(use-package verilog-ts-mode
:mode (("\\.s?vh?\\'" . verilog-ts-mode))
```
Expand Down Expand Up @@ -200,9 +200,13 @@ Enabling of `verilog-ext-mode` minor-mode creates the following keybindings:
# Features #

## Tree-sitter ##
The package `verilog-ts-mode` provides syntax highligting and indentation. It is derived from `verilog-mode` making AUTOs and other utilities still available.
The package `verilog-ts-mode` provides syntax highlighting,
indentation and a backend for hierarchy extraction, definitions and
references navigation, and some other features implemented in
`verilog-ext`. Using tree-sitter as a backend is recommended as it is
much faster and efficient than internal Emacs lisp parsing.

`verilog-ts-mode` is still work in progress and aims to provide the same functionality as `verilog-ext` but much faster and efficiently.
`verilog-ts-mode` is derived from `verilog-mode` making AUTOs and other utilities still available.

For more information see the [wiki](https://github.com/gmlarumbe/verilog-ext/wiki/Tree-sitter).

Expand Down

0 comments on commit f30cb5e

Please sign in to comment.