README
¶
hdl
Hdl is a tool for easing the work with hardware description languages.
Documentation
The documentation is included in the hdl binary.
Simply run hdl help or hdl help {command} to read about particular command.
Commands
The commands are:
doc- show or generate documentation,gen- generate code by processing sources,help- print more information about a specific command,ver- print hdl version,vet- check for likely mistakes.
Installation
go
go install github.com/m-kru/go-hdl/cmd/hdl@latest
Go installation installs to go configured path.
Manual
git clone https://github.com/m-kru/go-hdl.git
make
make install
Manual installation installs to /usr/bin.
Examples
doc
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
internal
|
|
|
args
Custom package for command line arguments parsing.
|
Custom package for command line arguments parsing. |
|
enc
Package enc implements functions for different number encodings.
|
Package enc implements functions for different number encodings. |
|
utils
Package for internal utilities.
|
Package for internal utilities. |
|
vet/rprt
Package rprt must be used to report violations to user.
|
Package rprt must be used to report violations to user. |
|
vhdl/re
Package re contains common regular expressions for VHDL.
|
Package re contains common regular expressions for VHDL. |
Click to show internal directories.
Click to hide internal directories.