aboutsummaryrefslogtreecommitdiffstats
path: root/ghw
diff options
context:
space:
mode:
authorumarcor <unai.martinezcorral@ehu.eus>2021-04-23 05:04:13 +0200
committertgingold <tgingold@users.noreply.github.com>2021-04-23 20:40:50 +0200
commite95c49da51e3be6e1d4022eb30934970bcd0bd94 (patch)
tree024407015065f03fca090057e416ce9d508ad527 /ghw
parent1d527b1353cd51d5c763b58382746be6b3531e08 (diff)
downloadghdl-e95c49da51e3be6e1d4022eb30934970bcd0bd94.tar.gz
ghdl-e95c49da51e3be6e1d4022eb30934970bcd0bd94.tar.bz2
ghdl-e95c49da51e3be6e1d4022eb30934970bcd0bd94.zip
Makefile: build and install ghwlib shared library
Diffstat (limited to 'ghw')
-rw-r--r--ghw/README.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/ghw/README.md b/ghw/README.md
index e64bbf769..300e10a74 100644
--- a/ghw/README.md
+++ b/ghw/README.md
@@ -4,6 +4,9 @@ This subdir contains C helpers for managing GHDL Wavefiles (GHW).
These sources are used in GTKWave for reading GHW waves (see [gtkwave/gtkwave/search?q=ghwlib](https://github.com/gtkwave/gtkwave/search?q=ghwlib)).
- `ghwlib.c` and `ghwlib.h` provide the reader library.
-- `ghwdump.c` uses the library for dumping the content of GHW files in text, for debugging purposes. `ghwdump` is built and installed with GHDL by default, and it is used in the test suite.
+- `ghwdump.c` uses the library for dumping the content of GHW files in text, for debugging purposes.
+
+A shared library named `ghwlib.[so|dll]` and `ghwdump` are built and installed with GHDL by default.
+Furthermore, `ghwdump` is used in the test suite.
These helpers are independent from GHDL's codebase. However, the GHW format is not specified, so it might change as a result of internal tweaks in GHDL. Hence, it is strongly suggested to use the helpers provided in the GHDL installation.