Merge pull request #84 from anjalijaiswal08/CleanUp

Issue number 79 solved.

2 files changed, 54 insertions, 11 deletions

diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md
new file mode 100644
index 00000000..a46bf859
--- /dev/null
+++ b/CONTRIBUTION.md
@@ -0,0 +1,24 @@
+## Contribution
+If you want to add any enhancement feature or have found any bug and want to work on it, please open a new issue regarding that and put a message "I would like to work on it." And make sure every pull request should reference to an issue.
+
+#### 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 ```
+
+* Always create a new branch before making any changes. You can create new branch using ```git branch <branch-name> ```
+
+* Checkout into your new branch using ```git checkout <branch-name>```
+
+* Make changes to code and once you are done use ```git add <path to file changed or added>```. Now commit  changes with proper message using ```git commit -m "Your message"```.
+
+* After commiting your changes push your changes to your forked repository using ```git push origin <branch-name>```
+Finally create a pull request from github.
+There should be only one commit per pull request.
+
+
+* Please follow below guidelines for your commit message :
+  * Commit message should be like : Fixes issue #[issue_number] - one line message of work you did.
+  * After commit message, there should be a commit body where you can mention what you did in short or in detail.
+
+Please follow above method to file pull requests.
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.