summaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..17860e3
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,14 @@
+NGHDL Installers
+====
+
+It contains all the documenation for making installations on various platforms.
+
+
+##How to package NGHDL with eSim?
+1. Add GHDL executable and the corresponding installer for the target OS in the `nghdl` folder.
+
+> Note : Instructions on how to generate GHDL executable and distribute it are provided under
+> respective target OS directory.
+
+2. Rename `nghdl` folder as `nghdl-master` and compress it to `.zip` format.
+3. Place this compressed file in `eSim-<version>` folder.