Skip to content

Commit

Permalink
WIP: UPdate README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gmlarumbe committed Aug 21, 2023
1 parent 794cce0 commit 51f6eb4
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
[![MELPA](https://melpa.org/packages/verilog-ext-badge.svg)](https://melpa.org/#/verilog-ext)
[![MELPA](https://melpa.org/packages/verilog-ts-mode-badge.svg)](https://melpa.org/#/verilog-ts-mode)
[![MELPA Stable](https://stable.melpa.org/packages/verilog-ext-badge.svg)](https://stable.melpa.org/#/verilog-ext)
[![Build Status](https://github.com/gmlarumbe/verilog-ext/workflows/ERT-straight/badge.svg)](https://github.com/gmlarumbe/verilog-ext/actions/workflows/build_straight.yml)
[![Build Status](https://github.com/gmlarumbe/verilog-ext/workflows/ERT-package-el/badge.svg)](https://github.com/gmlarumbe/verilog-ext/actions/workflows/build_package.yml)
Expand Down Expand Up @@ -33,9 +34,10 @@ This package provides some extensions on top of the great Emacs [verilog-mode](h

### MELPA ###

`verilog-ext` is available on MELPA.
`verilog-ext` is available on MELPA. It includes `verilog-ts-mode` as a dependency.

`verilog-ts-mode` is not yet available on MELPA. See the [wiki](https://github.com/gmlarumbe/verilog-ext/wiki/Tree-sitter) for more info.
If you only want to experiment with tree-sitter, `verilog-ts-mode` is also available on MELPA as a separate package.
See the [wiki](https://github.com/gmlarumbe/verilog-ext/wiki/Tree-sitter) for more info.


### straight.el ###
Expand Down Expand Up @@ -80,6 +82,8 @@ By default all features are enabled:
ports))
(verilog-ext-mode-setup)
(add-hook 'verilog-mode-hook #'verilog-ext-mode)
;; To use `verilog-ts-mode' as the default major-mode also add the line below:
(add-to-list 'auto-mode-alist '("\\.s?vh??\\'" . verilog-ts-mode))
```

If installed and loaded via `use-package`:
Expand Down Expand Up @@ -116,6 +120,10 @@ If installed and loaded via `use-package`:
ports))
:config
(verilog-ext-mode-setup))
;; To use `verilog-ts-mode' as the default major-mode also add the line below:
(use-package verilog-ts-mode
:mode (("\\.s?vh?\\'" . verilog-ts-mode))
```

## Workspace ##
Expand Down Expand Up @@ -149,7 +157,6 @@ To override the value of `workspace` root inside a Git repo:
Enabling of `verilog-ext-mode` minor-mode creates the following keybindings:

* Features:
* <kbd>M-i</kbd> `verilog-ext-imenu-list`
* <kbd>C-c C-l</kbd> `verilog-ext-formatter-run`
* <kbd>C-c \<f5\></kbd> `verilog-ext-workspace-compile`
* <kbd>C-c C-p</kbd> `verilog-ext-preprocess`
Expand Down Expand Up @@ -193,7 +200,7 @@ Enabling of `verilog-ext-mode` minor-mode creates the following keybindings:
# Features #

## Tree-sitter ##
The package provides the major-mode `verilog-ts-mode` for syntax highligting and indentation. It is derived from `verilog-mode` making AUTOs and other utilities still available.
The package `verilog-ts-mode` provides syntax highligting and indentation. It is derived from `verilog-mode` making AUTOs and other utilities still available.

`verilog-ts-mode` is still work in progress and aims to provide the same functionality as `verilog-ext` but much faster and efficiently.

Expand Down

0 comments on commit 51f6eb4

Please sign in to comment.