summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorrahulp132021-01-08 01:13:28 +0530
committerrahulp132021-01-08 01:13:28 +0530
commit1b5e07107e5fcf0269de20885a371b54049823e3 (patch)
treed518be49a0aacfdba9d18f99da73fc9d9fa7271f
parent595f84ed31eb214beb24e1e8a4bcfb090c1286c1 (diff)
downloadeSim-1b5e07107e5fcf0269de20885a371b54049823e3.tar.gz
eSim-1b5e07107e5fcf0269de20885a371b54049823e3.tar.bz2
eSim-1b5e07107e5fcf0269de20885a371b54049823e3.zip
updated readme
-rw-r--r--CONTRIBUTION.md2
-rw-r--r--README.md40
2 files changed, 22 insertions, 20 deletions
diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md
index a46bf859..ce6338b7 100644
--- a/CONTRIBUTION.md
+++ b/CONTRIBUTION.md
@@ -4,7 +4,7 @@ If you want to add any enhancement feature or have found any bug and want to wor
#### Points on how to make pull request
* You need to fork this repository to your account.
-* Clone it using ``` git clone https://github.com/[username]/eSim.git ```
+* Clone it using ``` git clone https://github.com/FOSSEE/eSim.git ```
* Always create a new branch before making any changes. You can create new branch using ```git branch <branch-name> ```
diff --git a/README.md b/README.md
index f30a6530..fdfb1838 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,26 @@
+![GitHub release (latest by date)](https://img.shields.io/github/v/release/fossee/esim?color=blueviolet)
+![GitHub](https://img.shields.io/github/license/fossee/esim?color=blue)
+![Python](https://img.shields.io/badge/python-v3.6+-blue.svg)
+[![PEP8](https://img.shields.io/badge/code%20style-pep8-orange.svg)](https://www.python.org/dev/peps/pep-0008/)
+![Travis (.org)](https://img.shields.io/travis/fossee/esim)
+[![Documentation Status](https://readthedocs.org/projects/esim/badge/?version=latest)](https://esim.readthedocs.io/en/latest/?badge=latest)
+[![GitHub forks](https://img.shields.io/github/forks/fossee/esim)](https://github.com/fossee/esim/network)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](https://github.com/fossee/esim)
+![GitHub contributors](https://img.shields.io/github/contributors/fossee/esim)
+
## eSim
[eSim](https://esim.fossee.in/) is an open source EDA tool for circuit design, simulation, analysis and PCB design, developed by [FOSSEE Team](https://www.fossee.in/) at [IIT Bombay](http://www.iitb.ac.in/).
It is an integrated tool build using open source softwares such as KiCad, Ngspice and GHDL.
-## Releases
+## Releases and Installation
+eSim is released for the following distributions (operating systems):
* Ubuntu 16.04 OS and above LTS versions.
* Microsoft Windows 7, 8 and 10.
-> Note: Refer [`installers`](https://github.com/fossee/eSim/tree/installers) branch for documentation on packaging for above mentioned platforms.
+To use eSim on your machine having above distributions, please refer to link [here](https://esim.fossee.in/downloads) for installation and other guidelines.
+
+> Note for other distributions: You can refer [`installers`](https://github.com/fossee/eSim/tree/installers) branch for documentation on packaging (for above mentioned distributions) to build installers for your operating system in a similar way. For providing your build, please check the `Contribution` section mentioned below.
## Features
* An open-source EDA tool.
@@ -20,28 +33,17 @@ It is an integrated tool build using open source softwares such as KiCad, Ngspic
## Open-Source Softwares Used
* [Python](https://www.python.org/)
-* [KiCad](http://www.kicad-pcd.org)
-* [Ngspice](http://ngspice.sourcefouge.net/)
-* [GHDL](http://ghdl.free.fr/)
-
-## Pre-requisites
-1. Python v3.5+
-2. Ngspice v31+
-3. KiCad v4.0.7
-4. [NGHDL](https://github.com/fossee/nghdl)
-
-## eSim Installation:
-
-To use eSim on your machine please refer to link [here](https://esim.fossee.in/downloads) for installation and other guidelines.
+* [KiCad](https://kicad.org/)
+* [NGHDL](https://github.com/fossee/nghdl)
## eSim Manual
-To know everything about eSim, how it works and it's feature please download manual [here](https://static.fossee.in/esim/installation-files/eSim_Manual_2.0.pdf)
+To know everything about eSim, how it works and it's feature please download manual [here](https://static.fossee.in/esim/manuals/eSim_Manual_2020_August.pdf)
## Contact
-For any queries regarding eSim please write us on at this [address](mailto:contact-esim@fossee.in).
+For any queries regarding eSim please write us on at this [email address](mailto:contact-esim@fossee.in).
## Contribution
-Please refer [here](https://github.com/FOSSEE/eSim/tree/master/CONTRIBUTION.md) for further details.
+Please refer [here](https://github.com/FOSSEE/eSim/blob/master/CONTRIBUTION.md) for further details.
## License
-It is developed by FOSSEE Team at IIT Bombay. It is released under GNU GPL License.
+It is developed by FOSSEE Team at IIT Bombay and is released under GNU GPL License.