From 226fa22ec5c419165c1b96e4779c9f8636f703a9 Mon Sep 17 00:00:00 2001 From: umarcor Date: Sat, 2 May 2020 13:59:57 +0200 Subject: [PATCH] update README.md --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 509197d9..faaa28c1 100644 --- a/README.md +++ b/README.md @@ -13,4 +13,10 @@ # Co-simulation with GHDL -This repository contains documentation and code examples about different procedures to interface VHDL with foreign languages and tools through GHDL. \ No newline at end of file +This repository contains **documentation** with code **examples** about different procedures to interface VHDL with foreign languages and tools through GHDL. + +Subdirs in [vhpidirect](./vhpidirect) and [vpi](./vpi) contain groups of examples to illustrate specific sets of features. Run the +`run.sh` script in each subdir in order to build and execute the group of examples. In some cases, there are further subdirs with +additional examples. Explanations are available in the [docs](https://ghdl.github.io/ghdl-cosim). + +*This repository was created recently and multiple existing examples are not published yet. Find on-going work in issue [#1](https://github.com/ghdl/ghdl-cosim/issues/1) and in [open Pull Requests](https://github.com/ghdl/ghdl-cosim/pulls)*.