diff --git a/README.md b/README.md index 2fc1d2049bd067bd8ddc32d21f8b13b7b99d5def..f7467cb6e27b659cd0ae8b90648428ab5d75a650 100644 --- a/README.md +++ b/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` diff --git a/set_env.sh b/set_env.sh index 09a7a60cae14d922498d553f5326dc41f3c01a6f..4f2410a3bbf7070f887de314a48b0431f0bc3a77 100755 --- a/set_env.sh +++ b/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 $@ diff --git a/soctools_flow b/soctools_flow index 348337022305cebea816cf80fb1eb8e5dd42632e..ccf4e4fbbf8c555cb5b8bf4e624c03f57052918d 160000 --- a/soctools_flow +++ b/soctools_flow @@ -1 +1 @@ -Subproject commit 348337022305cebea816cf80fb1eb8e5dd42632e +Subproject commit ccf4e4fbbf8c555cb5b8bf4e624c03f57052918d