summaryrefslogtreecommitdiff
path: root/Debian/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'Debian/readme.md')
-rw-r--r--Debian/readme.md25
1 files changed, 16 insertions, 9 deletions
diff --git a/Debian/readme.md b/Debian/readme.md
index eb8d2850..320bb153 100644
--- a/Debian/readme.md
+++ b/Debian/readme.md
@@ -1,4 +1,4 @@
-eSim Installer (Ubuntu)
+eSim Installer (Ubuntu OS)
====
@@ -40,9 +40,7 @@ It contains all the documenation for making eSim executable (using PyInstaller)
$ make
$ make install
-5. Now uninstall PyQt4, matplotlib, numpy, dateutil and cycler globally.
-
-6. Test whether only eSim dependencies are available or not:
+5. Test whether only eSim dependencies are available or not:
$ pip freeze
@@ -55,6 +53,8 @@ It contains all the documenation for making eSim executable (using PyInstaller)
> - six
> - cycler.py
+6. Download eSim Manual from eSim website, add it to `library/browser/User-Manual/` and update the file name of Manual in `src/browser/UserManual.py` accordingly.
+
7. Create spec file as:
$ pyi-makespec --onefile -n eSim <path_to_eSim>/src/frontEnd/Application.py
@@ -65,15 +65,17 @@ It contains all the documenation for making eSim executable (using PyInstaller)
$ pyinstaller -F --clean eSim.spec
-10. Verify whether all eSim `src` files (`*.py`) have been included in `Analysis-00.toc` file under the build folder generated by PyInstaller.
+11. Verify whether all eSim `src` files (`*.py`) have been included in `Analysis-00.toc` file under the build folder generated by PyInstaller.
## How to package eSim?
-1. Add the installer file in `eSim-<version>` folder.
-2. Add the eSim executable file in `eSim-<version>` folder.
-2. Remove following files from the folder:
+1. Update `VERSION` file to this release number.
+
+2. Add the installer file in `eSim-<version>` folder.
+
+3. Add the eSim executable file in `eSim-<version>` folder. Also, remove following files from the folder:
- `.git` folder
- `code` folder
- `src` folder
@@ -83,4 +85,9 @@ It contains all the documenation for making eSim executable (using PyInstaller)
- requirement.txt
- .gitignore
- .travis.yml
-3. Add the tar file of `NGHDL` in the eSim folder.
+
+4. Add the zip file of `NGHDL` (`nghdl-master.zip`) in the eSim folder.
+
+5. Compress `kicadLibrary` folder to a `tar.xz` format.
+
+6. Compress `eSim-<version>` to a zip format for distribution.