summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authoranjalijaiswal082019-06-10 15:54:56 +0530
committeranjalijaiswal082019-06-12 13:01:32 +0530
commit880f6eaa02416aacbc732728a91c7025841ea2e5 (patch)
tree036a465b610d2a169627df4bf9ade96793b5488c /README.md
parent19e57ec09fc6ddb8e1462ebc118841207497109b (diff)
downloadeSim-880f6eaa02416aacbc732728a91c7025841ea2e5.tar.gz
eSim-880f6eaa02416aacbc732728a91c7025841ea2e5.tar.bz2
eSim-880f6eaa02416aacbc732728a91c7025841ea2e5.zip
Fixes issue 79 - Improved README and added CONTRIBUTION
Diffstat (limited to 'README.md')
-rw-r--r--README.md41
1 files changed, 30 insertions, 11 deletions
diff --git a/README.md b/README.md
index ebde1d90..a3745ded 100644
--- a/README.md
+++ b/README.md
@@ -1,21 +1,40 @@
-##eSim
+## eSim
-eSim is an open source EDA tool for circuit design, simulation, analysis and PCB design, developed by FOSSEE team at IIT Bombay.
-It is an integrated tool build using open source software such as Kicad (http://www.kicad-pcd.org), Ngspice (http://ngspice.sourcefouge.net/)
-It is released under GNU GPL License. It runs on Ubuntu Linux, Windows XP and Windows.
+eSim is an open source EDA tool for circuit design, simulation, analysis and PCB design. It is an integrated tool build using open source software such as [KiCad](http://www.kicad-pcb.org/), [Ngspice](http://ngspice.sourceforge.net/)
-eSim has been successfully ported to low cost FOSSEE laptop (http://laptop.fossee.in)
+## Features
+* It is an open-source tool.
+* It can perform circuit design.
+* It can perform Simulation.
+* It can perform layout design.s
+* It also has a feature of Model builder and Subcircuit builder.
+* eSim has been successfully ported to low cost FOSSEE [laptop](http://laptop.fossee.in)
-##Pre-requisites
-1. Python 2.7
+## Open-Source Software Used
+* Python.
+* KiCad.
+* Ngspice.
+
+## Pre-requisites
+1. Python 3.0+
2. PyQt4
3. Matplotlib
-4. NgSpice
-5. Kicad (Latest Version build on July-14)
+4. NgSpice
+5. KiCad (latest version released on April-2019)
+
+## eSim Installation:
+
+To use eSim on your machine please refer to link [here](https://esim.fossee.in/downloads) for installation and other guidelines.
-## eSim Installation Ubuntu
-Refer INSTALL file for eSim installation on Ubuntu.
+## eSim Manual
+To know everything about eSim, how it works and it's feature please download manual [here](https://esim.fossee.in/resource/book/esimusermanual.pdf)
+## Contact
+For any queries regarding eSim please write us on at this [address](mailto:info@fossee.in).
+## Contribution
+Please refer [here](https://github.com/FOSSEE/eSim/tree/fellowship2019-python3/CONTRIBUTION.md) for further details.
+## License
+It is developed by FOSSEE team at IIT Bombay. It is released under GNU GPL License.