summaryrefslogtreecommitdiff
path: root/Windows/README.md
diff options
context:
space:
mode:
authorSumanto Kar2022-02-22 13:20:31 +0530
committerGitHub2022-02-22 13:20:31 +0530
commit0a046a7d4db025febef000464c27e8f4d6a276e6 (patch)
tree9e746aa0d149ccd8d7dfbd8a3d0d2975c3387b37 /Windows/README.md
parent1be38d711e2bdd63a39afda062a72ed12dd96fe5 (diff)
parenta08bb380ee2e2c421359d01b99b10e27907d3a11 (diff)
downloadeSim-0a046a7d4db025febef000464c27e8f4d6a276e6.tar.gz
eSim-0a046a7d4db025febef000464c27e8f4d6a276e6.tar.bz2
eSim-0a046a7d4db025febef000464c27e8f4d6a276e6.zip
Merge pull request #191 from rahulp13/installers
Installer updates for Verilator support
Diffstat (limited to 'Windows/README.md')
-rw-r--r--Windows/README.md46
1 files changed, 19 insertions, 27 deletions
diff --git a/Windows/README.md b/Windows/README.md
index 93d93c2d..b494e22b 100644
--- a/Windows/README.md
+++ b/Windows/README.md
@@ -29,36 +29,22 @@ It contains all the documentation for making eSim executable (using PyInstaller)
$ source eSim/Scripts/activate
-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==3.0.3
- $ pip install tornado
- $ pip install setuptools
- $ pip install PyQt5==5.9.2
- $ pip install pypiwin32
-
+6. Install the following Python dependencies through pip for eSim within the virtual environment:
+
+ $ pip install pyinstaller matplotlib==3.0.3 tornado setuptools
+ $ pip install PyQt5==5.9.2 pypiwin32 psutil
+ $ pip install watchdog hdlparse
+
7. Test whether only eSim dependencies are available or not:
$ pip freeze
-> 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:
$ pyi-makespec --onefile -n eSim <path_to_eSim>/src/frontEnd/Application.py --icon=<path_to_eSim_logo>
9. Create onefile executable using pyinstaller as:
-
+
$ 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.
@@ -83,7 +69,12 @@ It contains all the documentation for making eSim executable (using PyInstaller)
- `library/browser/User-Manual/figures` folder
- library/browser/User-Manual/eSim.html
-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.
+3. Remove following from `eSim\library\kicadLibrary` folder as same will be repeated in KiCad installer:
+ - entire `library` folder
+ - everything from `modules` folder except `Connectors_Terminal_Blocks.pretty/TerminalBlock_Altech_AK300-2_P5.00mm.kicad_mod` and `TO_SOT_Packages_THT.pretty/TO-220-3_Vertical.kicad_mod`
+ - everything from `temmplate` folder except `kicad.pro` file
+
+ Now, compress it in zip format, place it at `eSim\library` and delete that folder.
4. Add eSim user manual `eSim_Manual_<version>.pdf` at location `library/browser/User-Manual`.
@@ -102,12 +93,13 @@ It contains all the documentation for making eSim executable (using PyInstaller)
> Note: Refer this [documentation](https://github.com/fossee/KiCad-eSim/blob/executables/README.md) on packaging KiCad for Windows OS
10. Add following files/folder to the installer folder:
- - License file (`rtf` format).
- - Logo (`ico` format).
- - `esim-setup-script` file.
- - `nghdl-setup-script` file.
+ - License file (`rtf` format)
+ - Logo (`ico` format)
+ - `esim-setup-script` file
+ - Makerchip executables (`makerchip.7z` file)
+ - `nghdl-setup-script` file fromt the `NGHDL` repository
11. 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
+https://nsis-dev.github.io/NSIS-Forums/html/t-358040.html