summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b86b7c3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+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 NGHDL executable and distribute it along with GHDL 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.