From 924ab794db5f666e3ff38ba62f11a83cd90258bb Mon Sep 17 00:00:00 2001
From: jand <none@none>
Date: Wed, 14 May 2003 10:43:02 +0000
Subject: [PATCH] Icarus install instructions

---
 CHANGES.txt                    |  3 +--
 cosimulation/icarus/README.txt | 13 +++++++++++++
 2 files changed, 14 insertions(+), 2 deletions(-)
 create mode 100644 cosimulation/icarus/README.txt

diff --git a/CHANGES.txt b/CHANGES.txt
index fa78cb3f..d2320da6 100644
--- a/CHANGES.txt
+++ b/CHANGES.txt
@@ -2,8 +2,7 @@ Release 0.2 19-May-2003
 -----------------------
 * Added cosimulation support to MyHDL.
   
-A PLI interface module to the Icarus Verilog simulator is included in
-the release.
+A PLI interface module to the Icarus Verilog simulator is included.
 
 
 Release 0.1 7-Mar-2003
diff --git a/cosimulation/icarus/README.txt b/cosimulation/icarus/README.txt
new file mode 100644
index 00000000..90082214
--- /dev/null
+++ b/cosimulation/icarus/README.txt
@@ -0,0 +1,13 @@
+A working Icarus installation is required, so that the commands
+'iverilog' and 'vvp' are available.
+
+Run the Makefile by typing 'make'. This should generate a 'myhdl.vpi'
+module. Install it in an appropriate location, where 'vvp' can find
+it. Note that you can use the '-m' flag to vvp to specify the module
+path. 
+
+For cosimulation with MyHDL, 'vvp' should be run with the 'myhdl.vpi'
+PLI module, and the Verilog code should contain the appropriate task
+calls '$to_myhdl' and 'from_myhdl'.
+
+The 'myhdl.vpi' module was developed and verified with Icarus 0.7.