adding files

1 files changed, 27 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..8170bd80
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+##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 v.26
+5. Kicad 4.0.7 (Latest Version build on July-14)
+
+## eSim Installation Ubuntu
+Refer INSTALL file for eSim installation on Ubuntu.
+
+
+## For using the Cvpcb feature of KiCad in offline/online mode:
+Whether to look for footprints locally or through github is decided by fp-lib-table file.
+Currently we are forcing all users to look for footprints locally, by placing a fp-lib-table in the ~/.config/kicad/ directory. [Read copyKicadLibrary function in install-linux.sh]
+If you wish to use the Cvpcb tool[access the footprints available on kicad's github repo], open the fp-lib-table using gedit/text editors and replace the word "KISYSMOD" with "KIGITHUB", and replace the word "KiCad" with "Github" throughout the file.
+
+Two footprints are stored locally in /usr/share/kicad/modules/Connectors_Terminal_Blocks.pretty/
+and /usr/share/kicad/modules/TO_SOT_Packages_THT.pretty/ to keep eSim compliant with the Spoken Tutorials created.
+