From e92fbed3228e33eef34d9df66a067e1285b70e69 Mon Sep 17 00:00:00 2001
From: rahulp13
Date: Wed, 1 Apr 2020 19:48:35 +0530
Subject: update readme - packaging with src

---
 Debian/readme.md | 33 ++++++++++++++++++++++++++-------
 1 file changed, 26 insertions(+), 7 deletions(-)

(limited to 'Debian/readme.md')

diff --git a/Debian/readme.md b/Debian/readme.md
index c907fb0a..8b635e4a 100755
--- a/Debian/readme.md
+++ b/Debian/readme.md
@@ -2,7 +2,7 @@ eSim Installer (Ubuntu OS)
 ====
 
 
-It contains all the documenation for making eSim executable (using PyInstaller) and eSim Installation Script on Ubuntu 16.04 and above.
+It contains all the documenation for making eSim executable (using PyInstaller), eSim Installation Script and packaging eSim with and without eSim executable (through source) on Ubuntu 16.04 and above.
 
 
 ## eSim Executable:
@@ -74,7 +74,7 @@ It contains all the documenation for making eSim executable (using PyInstaller)
 9. Verify whether all eSim `src` files (`*.py`) have been included in `Analysis-00.toc` file under the build folder generated by PyInstaller.
 
 
-## Fully-Static Bundled Version of eSim:
+## Fully-Static Bundling of eSim Executable:
 
 1. To create a [fully-static bundled version](https://github.com/pyinstaller/pyinstaller/wiki/FAQ#GNULinux) of eSim (through PyInstaller), use a tool like [StaticX](https://github.com/JonathonReinhart/staticx/).
 
@@ -82,26 +82,45 @@ It contains all the documenation for making eSim executable (using PyInstaller)
 
 	- Activate the virtual environment as:
 	
-		$ source eSim/bin/activate
+			$ source eSim/bin/activate
 
 	- Install StaticX as:
 
-		$ pip install staticx
-		$ pip install patchelf-wrapper
+			$ pip install staticx
+			$ pip install patchelf-wrapper
 
 	- Create static eSim as:
 
-		$ staticx /path/to/executable/eSim /path/to/output/executable/eSim
+			$ staticx /path/to/executable/eSim /path/to/output/executable/eSim
 
 3. To verify if all dynamic libraries are removed :
 	
 	- Type following command in a terminal :
 
-		$ ldd path/to/output/executable/eSim
+			$ ldd path/to/output/executable/eSim
 
 	- Output of above command should be similar to `	not a dynamic executable`
 
 
+## Without eSim Executable (through source):
+
+Update following files by changing the relative paths before packaging the `src` folder with the release.
+
+	- `browser\UserManual.py` 				--> 	path to manual
+	- `browser\Welcome.py`					--> 	path to library
+	- `configuration\Appconfig.py`			--> 	path to library
+    - `frontEnd\Application.py`				--> 	path to library, pathmagic and images
+    - `frontEnd\ProjectExplorer.py`			--> 	path to images
+    - `frontEnd\Workspace.py`				--> 	path to images
+    - `kicadtoNgspice\DeviceModel.py` 		--> 	path to library
+    - `kicadtoNgspice\Processing.py` 		--> 	path to library
+    - `kicadtoNgspice\SubcircuitTab.py` 	--> 	path to library
+    - `modelEditor\ModelEditor.py`			--> 	path to library
+    - `subcircuit\newSub.py`				--> 	path to library
+    - `subcircuit\openSub.py`				--> 	path to library
+    - `subcircuit\uploadSub.py`				--> 	path to library
+
+
 ## How to package eSim?
 
 1. Update `VERSION` file to this release number.
-- 
cgit