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..b9bbb59
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+NGHDL Packaging
+====
+
+It contains all the documentation for packaging NGHDL to be distributed with [eSim](https://github.com/fossee/esim).
+
+
+## Packaging NGHDL with eSim?
+
+1. NGHDL is currently packaged for Ubuntu OS (Linux) and MS Windows OS.
+
+2. Refer the [documentation](Ngspice_Version_Change.md) for the changes to be done when the Ngspice is to be upgraded to a new verion. Note that these changes are common to both Ubuntu and Windows OS.
+
+3. Refer the [documentation](Ubuntu/README.md) to package eSim for Ubuntu OS.
+
+4. Refer the [documentation](Windows/README.md) to package eSim for Windows OS. \ No newline at end of file