Modern Hardware/Software Interface Documentation using Vue.js
Regvue
A modern web-based viewer for FPGA/ASIC register documentation.
|
Note
|
This repository is in the process of being migrated from JPL GitHub Enterprise to GitHub.com. The Git repository has been migrated but the issues, pull requests, and releases have not. |
Generate the Register Description
Generate the Regvue JSON according to the Register Description Format.
Install Regvue
The preferred method of installing Regvue is to not install it at all. Instead, use an existing deployment of Regvue managed by the Regvue team.
The latest deployment is https://nasa-jpl.github.io/regvue/v1/
Load a Register Description
Register descriptions can be loaded via the filesystem or via a URL.
Via a URL (Preferred)
URLs can be created that automatically load a hosted register description into Regvue.
For example,
-
the v1 deployment: https://nasa-jpl.github.io/regvue/v1/
-
and the demo register description: https://nasa-jpl.github.io/regvue/v1/example.json
-
can be paired as: https://nasa-jpl.github.io/regvue/v1/?data=https://nasa-jpl.github.io/regvue/v1/example.json
Via the Filesystem
Open Regvue and and load a register descriptions by dragging-and-dropping a register description JSON into Regvue or by using the file open dialog.