From 82cdb8faaedfaa0c7e860aa024e13bf25e0618b3 Mon Sep 17 00:00:00 2001 From: umarcor Date: Fri, 23 Apr 2021 04:24:28 +0200 Subject: ghw: add README.md --- ghw/README.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 ghw/README.md (limited to 'ghw/README.md') diff --git a/ghw/README.md b/ghw/README.md new file mode 100644 index 000000000..e64bbf769 --- /dev/null +++ b/ghw/README.md @@ -0,0 +1,9 @@ +# 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. `ghwdump` is built and installed with GHDL by default, and it 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. -- cgit v1.2.3