summaryrefslogtreecommitdiff
path: root/Windows
diff options
context:
space:
mode:
Diffstat (limited to 'Windows')
-rw-r--r--Windows/README.md (renamed from Windows/readme.md)25
1 files changed, 10 insertions, 15 deletions
diff --git a/Windows/readme.md b/Windows/README.md
index cd8ff979..8dae6dc1 100644
--- a/Windows/readme.md
+++ b/Windows/README.md
@@ -7,6 +7,7 @@ It contains all the documenation for making eSim executable (using PyInstaller)
> 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.
@@ -88,27 +89,24 @@ It contains all the documenation for making eSim executable (using PyInstaller)
> - six
> - cycler.py
-8. 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.
-
-9. Create spec file as:
+8. Create spec file as:
$ pyi-makespec --onefile -n eSim <path_to_eSim>/src/frontEnd/Application.py --icon=<path_to_eSim_logo>
-10. Create onefile executable using pyinstaller as:
+9. Create onefile executable using pyinstaller as:
$ pyinstaller -F --clean eSim.spec
-11. Verify whether all eSim `src` files (`*.py`) have been included in `Analysis-00.toc` file under the build folder generated by 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. Update `VERSION` file to this release number. Also, update version number in NSI script and `Installation.txt` file.
+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 file to the eSim source folder. Also, remove following files from the eSim source folder:
+3. Add eSim executable to the `eSim` folder. Also, remove following files from that folder:
- `.git` folder
- `code` folder
- `src` folder
@@ -118,15 +116,12 @@ It contains all the documenation for making eSim executable (using PyInstaller)
- requirement.txt
- .gitignore
- .travis.yml
- - `Examples\NGHDL_Examples\` folder
-
-4. Remove `eSim_Nghdl.lib` file from `eSim\library\kicadLibrary\kicad_eSim-Library\`. Also, remove `library` folder, duplicate files from `template` and `modules` folders under `eSim\library\kicadLibary\`.
-5. Now, compress `eSim\library\kicadLibrary` in zip format, place it at `eSim\library` and delete that folder.
+4. Now, compress `eSim\library\kicadLibrary` in zip format, place it at `eSim\library` and delete that folder.
-6. Compress `eSim` folder in zip format (Make sure that there is folder named `eSim` inside this compressed file).
+5. Compress `eSim` folder in zip format (Make sure that there is folder named `eSim` inside this compressed file).
-7. Add following files/folder to the installer folder:
+6. Add following files/folder to the installer folder:
- KiCad installer.
- License file (`rtf` format).
- Logo (`ico` format).
@@ -134,4 +129,4 @@ It contains all the documenation for making eSim executable (using PyInstaller)
- eSim (compressed file in `zip` format) containing eSim folder.
- `esim-setup-script` file.
-8. 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.