Bennett/Technical Documentation: Difference between revisions

From Engineering Wiki
Jump to navigation Jump to search
gravatar Mmapxam5 [userbureaucrateditorinterface-adminsysopPHRhYmxlIGNsYXNzPSJ0d3BvcHVwIj48dHI+PHRkIGNsYXNzPSJ0d3BvcHVwLWVudHJ5dGl0bGUiPkdyb3Vwczo8L3RkPjx0ZD51c2VyPGJyIC8+YnVyZWF1Y3JhdDxiciAvPmVkaXRvcjxiciAvPmludGVyZmFjZS1hZG1pbjxiciAvPnN5c29wPGJyIC8+PC90ZD48L3RyPjwvdGFibGU+] (talk | contribs)
No edit summary
gravatar Mbasszjg [userbureaucrateditorsysopPHRhYmxlIGNsYXNzPSJ0d3BvcHVwIj48dHI+PHRkIGNsYXNzPSJ0d3BvcHVwLWVudHJ5dGl0bGUiPkdyb3Vwczo8L3RkPjx0ZD51c2VyPGJyIC8+YnVyZWF1Y3JhdDxiciAvPmVkaXRvcjxiciAvPnN5c29wPGJyIC8+PC90ZD48L3RyPjwvdGFibGU+] (talk | contribs)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Overview ==
== Overview ==


Bennett is a hardware monitor application developed in house at the University of Manchester computer science department. It's used in several
Bennett is a hardware monitor application developed in house at the University of Manchester Computer Science department. It's used in several
undergraduate course units investigating Hardware design and Microncotrollers.
undergraduate course units investigating hardware design and microcontrollers.  It acts as a ‘front-end’ both for simulated (COMP15111)
and physical (COMP22712, COMP32211 …) RISC-V systems.


Bennett has been written in primarily C/C++ and uses the CMake build system.
Bennett has been written in primarily C/C++ and uses the CMake build system.


----


== Detailed Developer notes ==
== Detailed Developer notes ==


This article is an overview of Bennett and it's technical details. For the latest developer documentation, please see [https://gitlab.cs.man.ac.uk/mmapxam5/bennett/-/blob/master/README.md?ref_type=heads]
This article is an overview of Bennett and its technical details. For the latest developer documentation, please see [https://gitlab.cs.man.ac.uk/cadtools/bennett/-/blob/master/README.md?ref_type=heads https://gitlab.cs.man.ac.uk/cadtools/bennett/-/blob/master/README.md]
 


== Development ==
== Development ==


The source code for bennett is available [https://gitlab.cs.man.ac.uk/mmapxam5/bennett]
The source code for Bennett is available from [https://gitlab.cs.man.ac.uk/cadtools/bennett https://gitlab.cs.man.ac.uk/cadtools/bennett]


== Releases ==
== Releases ==


Latest releases of bennett are avilable at [https://gitlab.cs.man.ac.uk/mmapxam5/bennett/-/releases]
Latest releases of Bennett are available at [https://gitlab.cs.man.ac.uk/cadtools/bennett/-/releases https://gitlab.cs.man.ac.uk/cadtools/bennett/-/releases]


== CI/CD Pipeline ==
== CI/CD Pipeline ==
Line 24: Line 25:
Bennett uses a CI/CD pipeline to run automated tests, and automatically deploy the latest version.
Bennett uses a CI/CD pipeline to run automated tests, and automatically deploy the latest version.


New versions of bennett are automatically built and deployed to the [[cadmaster|cadtools]] server
New versions of Bennett are automatically built and deployed to the [[cadmaster|cadtools]] server.


     /cadtools5/bennett/version/<GIT_TAG>
     /cadtools5/bennett/version/<GIT_TAG>

Latest revision as of 13:19, 11 September 2025

Overview

Bennett is a hardware monitor application developed in house at the University of Manchester Computer Science department. It's used in several undergraduate course units investigating hardware design and microcontrollers. It acts as a ‘front-end’ both for simulated (COMP15111) and physical (COMP22712, COMP32211 …) RISC-V systems.

Bennett has been written in primarily C/C++ and uses the CMake build system.


Detailed Developer notes

This article is an overview of Bennett and its technical details. For the latest developer documentation, please see https://gitlab.cs.man.ac.uk/cadtools/bennett/-/blob/master/README.md

Development

The source code for Bennett is available from https://gitlab.cs.man.ac.uk/cadtools/bennett

Releases

Latest releases of Bennett are available at https://gitlab.cs.man.ac.uk/cadtools/bennett/-/releases

CI/CD Pipeline

Bennett uses a CI/CD pipeline to run automated tests, and automatically deploy the latest version.

New versions of Bennett are automatically built and deployed to the cadtools server.

   /cadtools5/bennett/version/<GIT_TAG>

Debian packages are available at

   /cadtools5/bennett/version/<GIT_TAG>

The pipeline additional collates required documentation and builds an output document.