diff --git a/README.md b/README.md index 99d56617e1aac86011407964d4907a7501297c1a..508162ebadd05a8dae2b4a59aabfc4463903c722 100644 --- a/README.md +++ b/README.md @@ -27,17 +27,21 @@ You will first need to add the path to the DMA-350 and BP301 (SIE300) logical di 2. Build configured IP If this is a fresh version of the repository, you can run: ```make first_time_setup``` + This will generate the RTL for the DMA-350 and BP301, it will also create a socrates project for the generation of the NIC400 RTL. You may see a lot of warnings during the building of the NIC400, these are expected. Once run you can check the logical/ directory of the local repository which should contain - DMA350, SMC, and nic400_expansion_subsystem If you have already run ```make first_time_setup``` or ```make make_project``` you can run: ```make build_ip``` which will build all of the necessary IP. + 3. Setup environment variables You can run ```source set_exp_env.sh``` which will setup the relevant environment variables ## Simulation Currently cocoTB is the only supported method of simulation, although a verilog testbench is under developement. + To run the current cocoTB verification go to verif/cocotb and run ```make``` + This will run the default tests for the expansion subsystem. You can edit the expansion_subsystem_tests.py file to include further tests ## Accelerator integration