From 6d8e4e44cd76b849ccea4b77bc0b9ffbea8be3e7 Mon Sep 17 00:00:00 2001 From: rahulp13 Date: Mon, 3 Aug 2020 17:33:20 +0530 Subject: initial commit --- Ubuntu/README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100755 Ubuntu/README.md (limited to 'Ubuntu/README.md') diff --git a/Ubuntu/README.md b/Ubuntu/README.md new file mode 100755 index 00000000..b4a6cb8b --- /dev/null +++ b/Ubuntu/README.md @@ -0,0 +1,32 @@ +eSim Installer (Ubuntu OS) +==== + +It contains the documentation to packaging eSim and making binaries for distribution. + +> Note: If planning to freeze the eSim source code for a target platform (Ubuntu OS), then refer this [documentation](executable.md). + + +## How to package eSim for Ubuntu OS? + +1. Take the `master` branch containing the source code. Rename the folder to `eSim-`. + +2. Add the installer script `install-eSim.sh` in `eSim-` folder. + +3. Add the eSim executable (if available) in `eSim-` folder. Also, remove following files from the folder: + - `.git` folder + - `code` folder + - `src` folder (Applicable only if eSim executable is used) + - conf.py + - setup.py + - index.rst + - requirement.txt + - .gitignore + - .travis.yml + +4. Add the zip file of `NGHDL` (`nghdl.zip`) in the eSim folder. + +> Note: Refer this [documentation](https://github.com/fossee/nghdl/tree/installers/Ubuntu/README.md) on packaging of NGHDL for Ubuntu OS. + +5. Compress `kicadLibrary` folder to a `tar.xz` format. + +6. Compress `eSim-` to a zip format for distribution. -- cgit From c3832418ddb492148886055611a78459673c05bf Mon Sep 17 00:00:00 2001 From: rahulp13 Date: Fri, 7 Aug 2020 18:21:38 +0530 Subject: update readme --- Ubuntu/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'Ubuntu/README.md') diff --git a/Ubuntu/README.md b/Ubuntu/README.md index b4a6cb8b..5c7c65d4 100755 --- a/Ubuntu/README.md +++ b/Ubuntu/README.md @@ -1,9 +1,9 @@ eSim Installer (Ubuntu OS) ==== -It contains the documentation to packaging eSim and making binaries for distribution. +It contains the documentation to package eSim for Ubuntu OS. -> Note: If planning to freeze the eSim source code for a target platform (Ubuntu OS), then refer this [documentation](executable.md). +> Note: If planning to freeze the eSim source code for a target platform (Ubuntu OS), then refer this [documentation](executable.md). Remember to update the installer script to work with this executable! ## How to package eSim for Ubuntu OS? @@ -12,7 +12,7 @@ It contains the documentation to packaging eSim and making binaries for distribu 2. Add the installer script `install-eSim.sh` in `eSim-` folder. -3. Add the eSim executable (if available) in `eSim-` folder. Also, remove following files from the folder: +3. Add the eSim executable (if available) in `eSim-` folder. Also, remove following files from this folder: - `.git` folder - `code` folder - `src` folder (Applicable only if eSim executable is used) -- cgit