summaryrefslogtreecommitdiff
path: root/Ubuntu/README.md
blob: b4a6cb8b59a6684f1e87b993bb73ad0f91af678d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
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-<version>`.

2. Add the installer script `install-eSim.sh` in `eSim-<version>` folder.

3. Add the eSim executable (if available) in `eSim-<version>` 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-<version>` to a zip format for distribution.