Skip to content

Latest commit

 

History

History
128 lines (74 loc) · 4.01 KB

README.md

File metadata and controls

128 lines (74 loc) · 4.01 KB

logo-text.png

                                        VHDL GENERATOR LOGO

Badges

Checkstyle Test Release

Overview

VHDL_GENERATOR is a java swing application that can generate VHDL Code it can generate the VHDL file given information of the VHDL interface(entity,port,signals, ...) and a Testbench template file also it can generate ready to use VHDL Component like(Mux,Demux,Adder,...).

Screenshot

Demos

  • VHDL Code generator
VG-Code.mp4
  • VHDL Component Generator
VG-Component.mp4

Requirements

  • Java jdk(>=18)

  • Maven

Maven Plugins

  • javadoc-plugin : for generating the javadoc

  • JUnit 5 : for unit testing

  • flatlaf: for the UI themes(Looks And Feels)

  • checkstyle : to enforce coding rules

  • formatter : for auto formatting code

  • assembly : for generating the Jar file with all dependencies

    Building&Running

    • you need to clone the repository first

      git clone https://github.com/Var7600/VHDL-GENERATOR

    • go to the VHDL-GENERATOR directory run

      1. Building
          mvn install
      1. Running
         java -jar target\VHDL_GENERATOR-0.0-SNAPSHOT-jar-with-dependencies.jar

Documentation

  • Javadoc : you can find the javadoc documentation of the project in Apidocs\Javadoc
  • UML : there's UML representation of the project in pdf file(you got to zoom in to see clearly)

TO DO(Upcoming)

  • add a option to directly generate testbench file by copying VHDL code to the editor or by choosing a VHDL file

  • add more Component in Library(Multiplier, Divider, Shifter, Floating Point Adder, T Flip-Flop, ROM, ALU . . . )

    Contributions

    If you want to contribute to a project and make it better, your help is very welcome. you can report bug reports/issues, feature requests and the noblest of all contributions: a good, clean pull request.

    adding component Library

    1. first you can create folder in HDL-library\ (ex: Multiplier)

    2. write your VHDL code there

    3. also a Testbench!

    4. then you can add a package in vhdlgenerator.component.Multiplier

    5. and follow same construction in others component class

    How to make a clean pull request

    • Create a personal fork of the project on Github.
    • Clone the fork on your local machine. Your remote repo on Github is called origin.
    • Add the original repository as a remote called upstream.
    • Create a new branch to work on! from main.
    • Implement/fix your feature, comment your code.
    • Follow the code style of the project, including indentation(some plugins(checkstyle,foramtter) by maven take care of that so you can write like you want and fix after)
    • If the project has tests run them!
    • Write or adapt tests as needed.
    • Add or change the documentation as needed.
    • Push your branch to your fork on Github, the remote origin.
    • From your fork open a pull request in the correct branch.
    • Once the pull request is approved and merged you can pull the changes from upstream to your local repo and delete your extra branch(es).

    License

    MIT