diff options
| author | rahulp13 | 2020-08-06 00:32:49 +0530 |
|---|---|---|
| committer | rahulp13 | 2020-08-06 00:32:49 +0530 |
| commit | 0a188e2be3c4ed5e0ca8ec52b69e9ee95dd89a8d (patch) | |
| tree | 5d0abd3da8b55458922adf41e2c54ed1cc2b748c | |
| parent | bef53fae3cf3f55024ffbdfe5886a531d4178300 (diff) | |
| download | nghdl-0a188e2be3c4ed5e0ca8ec52b69e9ee95dd89a8d.tar.gz nghdl-0a188e2be3c4ed5e0ca8ec52b69e9ee95dd89a8d.tar.bz2 nghdl-0a188e2be3c4ed5e0ca8ec52b69e9ee95dd89a8d.zip | |
updated readme
| -rw-r--r-- | README.md (renamed from readme.md) | 38 |
1 files changed, 18 insertions, 20 deletions
@@ -1,9 +1,7 @@ Ngspice Ghdl Interfacing Documentation ==== -It contains all the documenation for Ngspice and Ghdl related work. - -> Note: This project is in beta version and has been tested for rings, counters and PWM controllers. +It contains all the documentation for Ngspice and GHDL related work. ## How is Ngspice interfaced with GHDL? @@ -18,33 +16,33 @@ So the idea of interfacing is just to write VHDL code for a model and use it as GHDL's foreign language interface is used for this inter-process communication. -## Pre-requisites -1. Ubuntu 16.04-18.04 (You can try it on other version and let us know) -2. GHDL (LLVM)-0.36 -3. Ngspice-31 +## Releases +* 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. -## How to install? -This module is made available with eSim (Electronic Circuit Simulation). -Refer https://esim.fossee.in/ for more information. + +## Features +* Support for 500 digital models. +* Support for digital models upto 64 output ports/pins. +* Multiple instances of same digital model. -## Installed Code Structure -1. Ngspice will be installed in home directory $HOME. -2. Source code for all other file will be present in ~/.esim-nghdl -3. symlink "nghdl" is stored in /usr/local/bin +## Pre-requisites +* GHDL (LLVM)-v0.37 +* Ngspice-v31 -## Features -1. Support for 512 digital models. -2. Support for digital models upto 64 output ports/pins. -3. Multiple instances of same digital model. +## How to install? +This module is made available with eSim (Electronic Circuit Simulation). +Refer https://esim.fossee.in/ for more information. ## How to use the Examples provided with NGHDL? -1. Launch eSim --> Click on "NGHDL" icon from the left toolbar --> Click on "Browse" button --> Go to ../nghdl/Example/ +1. Launch eSim --> Click on "NGHDL" icon from the left toolbar --> Click on "Browse" button --> Go to `nghdl/Example/` 2. Locate the example you wish to simulate, find the VHDL file within that example and click on "Open" button at the bottom of "Open File" window. 3. Click on "Upload" button in the NGHDL window. File will be processed in the backend for few seconds. Now exit the NGHDL window. -4. Open the desired example under eSim/Examples/NGHDL_Examples/ using the "Open Project" button, double click on the project when the project is loaded in the "Projects" window. +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. |