Skip to content

rafiibrahim8/VerilogX

Repository files navigation

Stargazers Issues MIT License


VerilogX logo

A simple, easy, and fast Verilog Simulator

Table of Contents

About VerilogX

VerilogX is a Verilog simulation software that enables quick debugging of Verilog files. It uses Icarus Verilog (iverilog) and GTKWave to efficiently show output waveform.

Motivation

During the final year of my University, I had to use Verilog for one of my courses. The software we use to simulate was decades old. It took minutes to configure and view the resultant waveform. Debugging was a nightmare. Changing a single word in the code then simulating it took so much time I started to get angry.

I was looking for a way to easily run my Verilog files. Thus, VerilogX was born.

Getting Started

It's easy to install and run VerilogX.

Prerequisites

  • Code Editor

I recommend to use Visual Studio Code or Sublime Text 3 along with Verilog extension.

Note For Windows User

You need to have Java installed in your system. You can download Java (JRE) from here.

Installation

Linux

  • Download VerilogX-Linux-v0.1.tar.gz from here.

  • Open terminal at the downloaded location. And enter the following commands:

tar -xvf VerilogX-Linux-v0.1.tar.gz
cd VerilogX-Linux
sudo bash VerilogX-install.sh

Windows

  • Download VerilogX-Windows-v0.1.zip from here.
  • Unzip it.
  • Double click on VerilogX-Windows-v0.1.exe to install.

Roadmap

See the open issues for a list of problems, suggestions and solution (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Ibrahim Rafi - me@ibrahimrafi.me

Acknowledgements

Abdullah Al Mamun - mamunabdullah275@gmail.com - for designing the beautiful logo.

Pablo Bleyer Kocik - pablo.N@SPAM.bleyer.org - for Windows binary for iverilog and gtkwave.

Stephen Williams - steve@icarus.com - for Icarus Verilog (iverilog).

Free Software Foundation, Inc. - Website - for GTKWave.

Khude Gobeshok - Website - for their awesome README template.