summaryrefslogtreecommitdiff
path: root/Ubuntu/README.md
diff options
context:
space:
mode:
authorBladen Martin2020-08-06 19:16:04 +0530
committerGitHub2020-08-06 19:16:04 +0530
commitf6dab221722de039d70375a7692848f22c9be8a7 (patch)
tree455cfad11eac6d9a01e75924f54d31444c2e162e /Ubuntu/README.md
parent61fd2a0cec774a9076b1e45c53973a037d333147 (diff)
parent4e4d9e8285cbf9cedde362acf82ab79fdc5497d1 (diff)
downloadnghdl-f6dab221722de039d70375a7692848f22c9be8a7.tar.gz
nghdl-f6dab221722de039d70375a7692848f22c9be8a7.tar.bz2
nghdl-f6dab221722de039d70375a7692848f22c9be8a7.zip
Merge pull request #1 from rahulp13/installers
Installers
Diffstat (limited to 'Ubuntu/README.md')
-rw-r--r--Ubuntu/README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/Ubuntu/README.md b/Ubuntu/README.md
new file mode 100644
index 0000000..cbc0adb
--- /dev/null
+++ b/Ubuntu/README.md
@@ -0,0 +1,25 @@
+NGHDL Installer (Ubuntu OS)
+====
+
+It contains the documentation to package NGHDL for Ubuntu OS.
+
+> Note: If planning to freeze the NGHDL source code for a target platform (Ubuntu OS), then refer this [documentation](executable.md). Remember to update the installer script to work with this executable!
+
+## How to package NGHDL for Ubuntu OS?
+
+1. Take the `master` branch containing the source code. Rename the folder to `nghdl`.
+
+2. Add GHDL source code `ghdl-<version>.tar.xz` in the `nghdl` folder.
+
+3. Add the installer script `install-nghdl.sh` in the `nghdl` folder.
+
+4. Add the NGHDL executable (if available) in `nghdl/src` folder. Also, remove following files from this folder:
+ - `.git` folder
+ - all python files (Applicable only if eSim executable is used)
+ - GHDLside.md
+ - Workflow.md
+ - .gitignore
+
+2. Compress it to `.zip` format.
+
+3. Place this compressed file in `eSim-<version>` folder.