diff options
Diffstat (limited to 'code/installation.rst')
-rw-r--r-- | code/installation.rst | 77 |
1 files changed, 77 insertions, 0 deletions
diff --git a/code/installation.rst b/code/installation.rst new file mode 100644 index 00000000..84f067ee --- /dev/null +++ b/code/installation.rst @@ -0,0 +1,77 @@ +Installation +=========================== + +This guide will help you install eSim on both Ubuntu (Linux) and Microsoft Windows operating systems. + +**Table of Contents** + +1. `eSim installation on Ubuntu OS (Linux) <#ubuntu-installation>`_ +2. `eSim installation on Microsoft Windows OS <#windows-installation>`_ +3. `Support <#support>`_ + +.. _ubuntu-installation: + +eSim Installation on Ubuntu OS (Linux) +----------------------------------------- + +**Step 1:** After downloading eSim, extract it using: + + ``$ unzip eSim-2.5.zip`` + +**Step 2:** Change directories into the top-level eSim directory (where this INSTALL file can be found). + +**Step 3:** To install eSim and its dependencies, run: + + ``$ chmod +x install-eSim.sh`` + + ``$ ./install-eSim.sh --install`` + +**Step 4:** To uninstall eSim and all of its components, run: + + ``$ ./install-eSim.sh --uninstall`` + + +**How to Run eSim** + +**A. Through Terminal** + + ``$ esim`` + +**B. Double-click the eSim desktop icon** + +.. _windows-installation: + +eSim Installation on Microsoft Windows OS +-------------------------------------------- + +**Step 1:** Download eSim for Windows from https://esim.fossee.in/. +*Disable your antivirus (if any) before proceeding.* + +**Step 2:** If MinGW and/or MSYS is already installed on your machine, remove it from the PATH environment variable as it may interfere with eSim. + +**Step 3:** Double-click the eSim installer and follow the instructions to install eSim. + +**Step 4:** After installation, download and add the following file to the eSim home directory (`FOSSEE\eSim\`): + + https://github.com/FOSSEE/eSim/blob/master/src/frontEnd/TerminalUi.ui#L6 + +**Step 5:** Download and add the following executable to the `nghdl` folder (`FOSSEE\eSim\nghdl\src`): + + https://drive.google.com/file/d/17MNCCq9cG6A7fnIH-4KMUMY-yb4rW9s4/view?usp=sharing + +**Step 6:** Installation is now complete. + +**Step 7:** To uninstall eSim and all of its components, run the uninstaller `uninst-eSim.exe` located in the top-level eSim directory. + +.. _support: + +Support +--------- + +If you encounter any issues or errors during installation, please report them at: +https://github.com/FOSSEE/eSim + +For any queries regarding eSim, please write to us at +`contact-esim@fossee.in <mailto:contact-esim@fossee.in>`_ + +--- |