The application is designed to help novice HDL developers to visualise digital schematic developed in Verilog, providing users with smart editing tools, fast feedback(error messaging) and basic interaction with the schematic such as zooming functionality.
The main framework is based on the basis template provided by https://github.com/fable-compiler/samples-electron.
The application code is developed in 'F#' which is further transpiled to 'JavaScript' using FABLE. In order to create a desktop application from web-app, Electron.js is used.
Monaco Editor is a 'JavaScript' library that implements the editor window in the application.
Yosys.js provides a 'Verilog' parser used in the application.
Viz.js provides a graphics engine used to render the visualisation of the digital schematic.
- Node.js 6.11 or higher
- dotnet SDK 2.0 or higher
- 'Yarn' or 'npm' JavaScript dependency manager
- Install the requirements mentioned above.
- Clone the VeriEd repository.
- Use command-line interpreter to find the root folder.
- Install JavaScript dependencies using 'yarn install' or 'npm install'
- Install .NET dependencies using 'dotnet restore'
- Run 'yarn start' or 'npm start' for compiling 'F#' into 'JavaScript'. This action compiles all the code at once and looks after any changes made to the source files, recompiling on change.
- Run 'yarn launch' or 'npm launch' to open the 'Electron.js' application which renders the 'HTML, CSS and JavaScript' code.