From 55f6f20fb6fb4c70f11617813ce7fe5de4af48e8 Mon Sep 17 00:00:00 2001 From: dam1n19 <dam1n19@soton.ac.uk> Date: Wed, 5 Jul 2023 16:15:34 +0100 Subject: [PATCH] Updated readme --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 7275fc3..a538072 100644 --- a/README.md +++ b/README.md @@ -52,6 +52,16 @@ Once you have run a `source set_env.sh` in your current terminal, you are then a This runs a git pull on all repositories in your project. +# Project Structure + +The core of the SoC is NanoSoC. This is an example, configurable system that is the main framework. It has many different memory-mapped regions, one of which is designed for the connection of accelerator subsystems called the expansion region. + +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. + +`accelerator_subsystem` can either directly contain an accelerator (or multiple) or can instantiate accelerator wrappers which in turn instantiate accelerators. + +This module is expected to be found in `system/src/accelerator_subsystem.v`. + ## Running the simulation socsim is a tool that SoC Labs have developed that allows for running of shell scripts anywhere within your project environment. The idea is these scripts can be customised to run scripts for different simulators. -- GitLab