summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorrahulp132020-08-06 01:55:36 +0530
committerrahulp132020-08-06 01:55:36 +0530
commitf9f56ff487b16c312143bd4e81949f4f5db1e9e8 (patch)
tree50566e89a7b5300d5b64febf8ec2333831c74a88 /README.md
parentec19a271375aa1063456ba81012446c9d629b087 (diff)
downloadnghdl-f9f56ff487b16c312143bd4e81949f4f5db1e9e8.tar.gz
nghdl-f9f56ff487b16c312143bd4e81949f4f5db1e9e8.tar.bz2
nghdl-f9f56ff487b16c312143bd4e81949f4f5db1e9e8.zip
updated doc files
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 8 insertions, 8 deletions
diff --git a/README.md b/README.md
index b86b7c3..b9bbb59 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,15 @@
-NGHDL Installers
+NGHDL Packaging
====
-It contains all the documenation for making installations on various platforms.
+It contains all the documentation for packaging NGHDL to be distributed with [eSim](https://github.com/fossee/esim).
-## How to package NGHDL with eSim?
-1. Add GHDL executable and the corresponding installer for the target OS in the `nghdl` folder.
+## Packaging NGHDL with eSim?
-> Note : Instructions on how to generate NGHDL executable and distribute it along with GHDL are
-> provided under respective target OS directory.
+1. NGHDL is currently packaged for Ubuntu OS (Linux) and MS Windows OS.
-2. Rename `nghdl` folder as `nghdl-master` and compress it to `.zip` format.
+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. Place this compressed file in `eSim-<version>` folder.
+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