updated packaging instructions

1 files changed, 39 insertions, 58 deletions

diff --git a/Windows/README.md b/Windows/README.md
index 8dae6dc1..cf64a58f 100644
--- a/Windows/README.md
+++ b/Windows/README.md
@@ -1,16 +1,15 @@
 eSim Installer (Windows OS)
 ====
 
+It contains all the documentation for making eSim executable (using PyInstaller) and packaging eSim for Windows 7 and above.
 
-It contains all the documenation for making eSim executable (using PyInstaller) and eSim Installation Script on Windows 7 and above.
-
-> Note : Do not develop eSim on Windows OS. Work only with `installers` branch on Windows OS and do development on Linux OS.
+> Note: Do not develop eSim on Windows OS. Work only with `installers` branch on Windows OS and do development on Linux OS.
 > Reference : https://stackoverflow.com/questions/37672886/cannot-get-rid-of-unstaged-files-in-git-on-my-local
 
 
 ## eSim Executable:
 
-1. Download and install "Python-3.5.2", "Git For Windows". Use "Git Bash" for all following shell commands.
+1. Download and install "Python-3.6.8", "Git For Windows". Use "Git Bash" for all following shell commands. Ensure that `tcl/tk` (`tkinter`) is also installed with Python as it is required by `matplotlib` dependency
 		
 		Reference - https://gitforwindows.org/
 
@@ -30,64 +29,29 @@ It contains all the documenation for making eSim executable (using PyInstaller)
 	
 		$ source eSim/Scripts/activate
 
-6. Install all Python dependencies for eSim within the virtual environment as:
-		
-		- Install PyInstaller, Matplotlib, tornado, SetupTools through pip :
+6. Install the Python dependencies `PyInstaller`, `Matplotlib`, `Tornado`, `SetupTools`, `PyQt5`, `Pypiwin32` through pip for eSim within the virtual environment:
 
 			$ pip install pyinstaller
-			$ pip install matplotlib
+			$ pip install matplotlib==3.0.3
 			$ pip install tornado
-			$ pip install --upgrade 'setuptools<45.0.0'
+			$ pip install setuptools
+			$ pip install PyQt5
+			$ pip install pypiwin32
 		
-		- Install PyQt4 through pip (Reference - https://stackoverflow.com/questions/22640640/how-to-install-pyqt4-on-windows-using-pip) :
-			
-			$ pip install --upgrade 'sip<5.0.0'
-			$ pip install <wheel_package_of_PyQt4>
-
-			> Note : 
-				- If there are any issues regarding loading of DLL files, refer : https://stackoverflow.com/questions/2738879/cannot-import-pyqt4-qtgui
-				- If above step works, then goto step 7.
-
-		- Install PyQt4 from source :
-
-			- Add following Linux packages to MINGW64 of Git :
-		
-				- `make` (get the version without guile)
-				- `wget`
-
-    			Reference - https://gist.github.com/evanwill/0207876c3243bbb6863e65ec5dc3f058
-
-    		- Install MINGW64 on your system and merge all the files from `mingw-w64` to `Git\mingw-w64` (do not replace or copy blindly).
-
-    		- Now open Git-Bash and run following commands :
-    		
-				$ mkdir eSim/build
-				$ cd eSim/build/
-				$ wget http://sourceforge.net/projects/pyqt/files/PyQt4/PyQt-4.12.3/PyQt4_gpl_x11-4.12.3.tar.gz
-				$ wget https://www.riverbankcomputing.com/static/Downloads/sip/4.19.21/sip-4.19.21.tar.gz
-				$ tar -xzvf sip-4.19.21.tar.gz
-				$ tar -xvzf PyQt4_gpl_x11-4.12.3.tar.gz
-				$ cd sip-4.19.21/
-				$ python configure.py --sip-module PyQt4.sip --platform win32-g++
-				$ make
-				$ make install
-				$ cd ../PyQt4_gpl_x11-4.12.3/
-				$ python configure.py
-				$ make
-				$ make install
-
 7. Test whether only eSim dependencies are available or not:
 
 		$ pip freeze
 
-> Note : Following dependencies should be available -
->	- PyQt4
+> Note: Following Python packages for eSim along with their dependencies should be available -
+>	- PyQt5
+>	- PyQt5-sip
 >	- matplotlib
 >	- numpy
 >	- dateutil
 >	- pyparsing
 >	- six
 >	- cycler.py
+>	- pypiwin32
 
 8. Create spec file as:
 
@@ -100,13 +64,12 @@ It contains all the documenation for making eSim executable (using PyInstaller)
 10. 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. Take the `master` branch of eSim. Rename the folder to `eSim`.
 
-2. Compress `spice` folder in zip format (Make sure that there is folder named `spice` inside this compressed file).
-
-3. Add eSim executable to the `eSim` folder. Also, remove following files from that folder:
+2. Add eSim executable (`eSim.exe`) to the `eSim` folder. Also, remove following files from that folder:
 	- `.git` folder
 	- `code` folder
 	- `src` folder
@@ -116,17 +79,35 @@ It contains all the documenation for making eSim executable (using PyInstaller)
 	- requirement.txt
 	- .gitignore
 	- .travis.yml
+	- INSTALL
+    - `library/browser/User-Manual/figures` folder
+    - library/browser/User-Manual/eSim.html
 
-4. Now, compress `eSim\library\kicadLibrary` in zip format, place it at `eSim\library` and delete that folder.
+3. Remove entire `library` folder and duplicate files from `template` and `modules` folders from `eSim\library\kicadLibrary` as same will be repeated in KiCad installer. Now, compress it in zip format, place it at `eSim\library` and delete that folder.
 
-5. Compress `eSim` folder in zip format (Make sure that there is folder named `eSim` inside this compressed file).
+4. Add eSim user manual `eSim_Manual_<version>.pdf` at location `library/browser/User-Manual`.
 
-6. Add following files/folder to the installer folder:
-	- KiCad installer.
+5. Replace `LICENSE` file with `LICENSE.rtf` file in `eSim` folder.
+
+6. Compress `eSim` folder in 7z format and add it to the installer folder (Make sure that there is folder named `eSim` inside this compressed file).
+
+7. Add the dependencies for `NGHDL` to the installer folder.
+
+> Note: Refer this [documentation](https://github.com/fossee/nghdl/tree/installers/Windows/README.md) on packaging NGHDL for Windows OS.
+
+8. Apply NSIS plugins. Refer [here](https://github.com/fossee/nghdl/tree/installers/Windows/NSISplugins/) for the same.
+
+9. Add KiCad installer `kicad-4.0.7-i686.exe` to the installer folder.
+
+> Note: Refer this [documentation](https://github.com/fossee/KiCad-eSim/blob/master/README.md) on packaging KiCad for Windows OS
+
+10. Add following files/folder to the installer folder:
 	- License file (`rtf` format).
 	- Logo (`ico` format).
-	- Spice (compressed file in `zip` format) containing spice folder.
-	- eSim (compressed file in `zip` format) containing eSim folder.
 	- `esim-setup-script` file.
+	- `nghdl-setup-script` file.
+
+11. Compile the NSI script (`esim-setup-script` file). Now only use the generated installer for distribution.
 
-7. Compile the NSI script (`esim-setup-script` file). Now only use the generated installer for distribution.
+> Note: If there is any warning on `Eliminating "zeroing code out"`, then have a look at this reference -
+https://nsis-dev.github.io/NSIS-Forums/html/t-358040.html
\ No newline at end of file