summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorrahulp132021-01-08 00:46:16 +0530
committerrahulp132021-01-08 00:46:16 +0530
commit6536595225331febcb60422a8b8d2dde1520c982 (patch)
treea6f0555a090358ec2619f1ed48995ebdfaf682db
parentaf4fe5b34e291cfe3bb1dadb967a8a049bf9ee64 (diff)
downloadnghdl-6536595225331febcb60422a8b8d2dde1520c982.tar.gz
nghdl-6536595225331febcb60422a8b8d2dde1520c982.tar.bz2
nghdl-6536595225331febcb60422a8b8d2dde1520c982.zip
update readme
-rw-r--r--CONTRIBUTION.md25
-rw-r--r--README.md19
2 files changed, 40 insertions, 4 deletions
diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md
new file mode 100644
index 0000000..dec42e8
--- /dev/null
+++ b/CONTRIBUTION.md
@@ -0,0 +1,25 @@
+## 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/FOSSEE/nghdl.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 8e7ef7d..d9cb62d 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,11 @@
+![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/fossee/nghdl?color=blueviolet)
+![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/)
+[![GitHub forks](https://img.shields.io/github/forks/fossee/nghdl)](https://github.com/fossee/nghdl/network)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](https://github.com/fossee/nghdl)
+![GitHub contributors](https://img.shields.io/github/contributors/fossee/nghdl)
+
+
Ngspice Ghdl Interfacing Documentation
====
@@ -5,7 +13,7 @@ It contains all the documentation for Ngspice and GHDL related work.
## How is Ngspice interfaced with GHDL?
-Ngspice supports mixed mode simulation. It can simulate both digital and analog components.
+Ngspice supports mixed-signal simulation. It can simulate both digital and analog components.
Ngspice has something called code-model which defines the behavior of your component and can be used in the netlist. For example you can create a full-adder's code-model in Ngspice and use it in any circuit netlist of Ngspice.
@@ -20,7 +28,7 @@ GHDL's foreign language interface is used for this inter-process communication.
* Ubuntu 16.04 OS and above LTS versions.
* Microsoft Windows 7, 8 and 10.
-> Note: Refer [`installers`](https://github.com/fossee/nghdl/tree/installers) branch for documentation on packaging for above mentioned platforms.
+ > Note for other distributions: You can refer [`installers`](https://github.com/fossee/nghdl/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
@@ -30,8 +38,8 @@ GHDL's foreign language interface is used for this inter-process communication.
## Pre-requisites
-* GHDL (LLVM)-v0.37
-* Ngspice-v31
+* [GHDL (LLVM - v0.37)](http://ghdl.free.fr/)
+* [Ngspice (v31+)](http://ngspice.sourceforge.net/)
## How to install?
@@ -46,3 +54,6 @@ Refer https://esim.fossee.in/ for more information.
4. Open the desired example under `eSim/Examples/Mixed_Signal/` using the "Open Project" button, double click on the project when the project is loaded in the "Projects" window.
5. Click on the "Simulation" button on eSim Main window.
+
+## Contribution
+Please refer [here](https://github.com/FOSSEE/nghdl/blob/master/CONTRIBUTION.md) for further details.