From e6c60710e6b7ac339d7c86a3b3b6ce8d3b78f4c6 Mon Sep 17 00:00:00 2001
From: dwf1m12 <d.w.flynn@soton.ac.uk>
Date: Wed, 12 Jul 2023 16:50:25 +0100
Subject: [PATCH] fix html generation (as no accelerator RTL), and add README
 usage instructions

---
 README.md                       | 11 +++++++++++
 flist/project/accelerator.flist |  6 +++---
 2 files changed, 14 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 7e4f6df..a187598 100644
--- a/README.md
+++ b/README.md
@@ -41,6 +41,17 @@ The core of the SoC is NanoSoC. This is an example, configurable system that is
 
 The expansion region is able to instantiate an accelerator_subsystem by default. This means that anyone using NanoSoC as a platform for accelerator experimentation will need to build an `accelerator_subsystem` rtl module.
 
+
+### htmlgen design visualisation
+---
+A tool is provided to generate an html documentation tree to traverse and explore the design hierarchy:
+
+`htmlgen -f $SOCLABS_PROJECT_DIR/flist/project/top.flist`
+or
+ `htmlgen`
+populates the html/top/build/ directiory. Open `nanosoc_tb.html` to explore from the testbench down in to the design.
+
+
 ### Accelerator Subsystem
 ---
 `accelerator_subsystem` can either directly contain an accelerator (or multiple) or can instantiate accelerator wrappers which in turn instantiate accelerators.
diff --git a/flist/project/accelerator.flist b/flist/project/accelerator.flist
index 2bf1f3c..2166f19 100644
--- a/flist/project/accelerator.flist
+++ b/flist/project/accelerator.flist
@@ -14,10 +14,10 @@
 // =============    Accelerator Module search path    =============
 
 // ! Point this to your Accelerator RTL
-+incdir+$(ACCELERATOR_DIR)/src/rtl
+//+incdir+$(ACCELERATOR_DIR)/src/rtl
 
 // ! Point this to your Wrapper RTL
-$(SOCLABS_PROJECT_DIR)/wrapper/src/soclabs_ahb_aes128_ctrl.v
+///$(SOCLABS_PROJECT_DIR)/wrapper/src/soclabs_ahb_aes128_ctrl.v
 
 // ! Point this to your Subsystem RTL
-$(SOCLABS_PROJECT_DIR)/system/src/accelerator_subsystem.v
\ No newline at end of file
+///$(SOCLABS_PROJECT_DIR)/system/src/accelerator_subsystem.v
-- 
GitLab