Merge branch accelerator-project:main into main

README.md

@@ -2,12 +2,32 @@
 
 This repo is the top-level repository which contains an example accelerator based on the secworks AES engine integrated in SoC Labs provided nanosoc chip design IP in forms of git subrepositories.
 
-The SoC wiring is handled in this repository too, along with design and verification for accelerator wrappers.
+Please Fork this repository in order to build your own custom project. This can be done through the git.soton.ac.uk/soclabs/accelerator-project website and create your own custom project folder which you can then customise to suit your needs.
 
-## Re-creating the top-level design
+## Cloning this repository
+
+This Repository contains multiple sub-repositories. In order to clone them with this repository, please use the following command:
+
+`git clone --recurse https://git.soton.ac.uk/soclabs/accelerator-project.git`
+
+This will clone this base repository. Change the url in the command above to clone your fork instead of the base repository.
+
+## Setting up the Project Environment
+
+In order to checkout all the sub-repositories in your project to their branches and set up your local environment variables, from the top-level of this project run:
 
+`source set_env.sh`
+
+## Adding a Custom Accelerator Repository
+
+Custom accelerator repsitories can be added to your forked project using the following commands:
+
+`cd $SOCLABS_PROJECT_DIR; git submodule add youracceleratorurl.git`
+
+Once this has been done, you should see a folder at the top-level of your project containing your accelerator repository. This will be on 
+## Re-creating the top-level design
 
-Set up the environment variables and paths for this prohect:
+Set up the environment variables and paths for this project:
 
 `source set_env.sh` 
 

nanosoc_tech @ 35345e85

-Subproject commit d8cd630b7f280dd8c2ff6bace8e5ec053ebad97f
+Subproject commit 35345e854d19cfb8a992197a2ac7db03e1cf7972

set_env.sh

@@ -11,4 +11,4 @@
 #!/bin/bash
 
 # Source set_env script from soctools_flow
-source soctools_flow/bin/project_setup.sh
+source soctools_flow/bin/project_setup.sh $@

soctools_flow @ ccf4e4fb

-Subproject commit 348337022305cebea816cf80fb1eb8e5dd42632e
+Subproject commit ccf4e4fbbf8c555cb5b8bf4e624c03f57052918d