summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorfahim2015-07-15 14:50:49 +0530
committerfahim2015-07-15 14:50:49 +0530
commitc528f83cb20384b55533f13e138b9ffeab3463cb (patch)
tree536c572a05a9d7db7a203b70639bc55cbdddbd46 /README.md
parent24fe576e3cdf1e22293ba86c9436cdb6942d163a (diff)
downloadeSim-c528f83cb20384b55533f13e138b9ffeab3463cb.tar.gz
eSim-c528f83cb20384b55533f13e138b9ffeab3463cb.tar.bz2
eSim-c528f83cb20384b55533f13e138b9ffeab3463cb.zip
Subject: Updated README file
Description: Updated README file
Diffstat (limited to 'README.md')
-rw-r--r--README.md51
1 files changed, 50 insertions, 1 deletions
diff --git a/README.md b/README.md
index 7f51c847..bd61627b 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,50 @@
-# 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 has been successfully ported to low cost FOSSEE laptop (http://laptop.fossee.in)
+
+##Pre-requisites
+1. Python 2.7
+2. PyQt4
+3. Matplotlib
+4. NgSpice
+5. Kicad (Latest Version build on July-14)
+
+##Installing and setting PATH for eSim
+1. Clone this repository or download it as zip file.
+2. set PYTHONPATH
+ - For Linux :
+ Open .bashrc file and add this line.
+
+ `export PYTHONPATH=$PYTHONPATH:/path-to-your-downloaded-folder/eSim/src`
+
+ - For Window :
+ set environment variable `PYHTONPATH` with complete path to your eSim/src
+
+
+##How to run eSim ?
+1. Using command line or terminal go to location eSim/src/frontEnd
+2. Type below command to open eSim
+ `python Application.py`
+
+
+##How to install latest version of kicad in Ubuntu ?
+1.Add PPA to your repository
+ `sudo add-apt-repository ppa:js-reynaud/ppa-kicad`
+
+2. Update your repo
+ `sudo apt-get update`
+
+3. Install kicad
+ `sudo apt-get install kicad`
+
+
+##How to install ngspice in Ubuntu?
+
+ `sudo apt-get install ngspice`
+
+
+