aboutsummaryrefslogtreecommitdiffstats
path: root/ghw
diff options
context:
space:
mode:
authorumarcor <unai.martinezcorral@ehu.eus>2021-04-23 17:46:37 +0200
committertgingold <tgingold@users.noreply.github.com>2021-04-23 20:40:50 +0200
commit026006aec2f37328edc8540472920ef0fbc591b9 (patch)
treeddc3ebc9700922002024bcf1a70d199a4ca3b07f /ghw
parente95c49da51e3be6e1d4022eb30934970bcd0bd94 (diff)
downloadghdl-026006aec2f37328edc8540472920ef0fbc591b9.tar.gz
ghdl-026006aec2f37328edc8540472920ef0fbc591b9.tar.bz2
ghdl-026006aec2f37328edc8540472920ef0fbc591b9.zip
doc: add section about GHW
Diffstat (limited to 'ghw')
-rw-r--r--ghw/README.md12
1 files changed, 0 insertions, 12 deletions
diff --git a/ghw/README.md b/ghw/README.md
deleted file mode 100644
index 300e10a74..000000000
--- a/ghw/README.md
+++ /dev/null
@@ -1,12 +0,0 @@
-# GHDL Wavefile helpers
-
-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.
-
-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.