diff options
author | m8pple <dt10@imperial.ac.uk> | 2014-10-20 13:31:20 +0100 |
---|---|---|
committer | m8pple <dt10@imperial.ac.uk> | 2014-10-20 13:31:20 +0100 |
commit | 599b598ec51fe84d425f2d5ed3d18642c1285029 (patch) | |
tree | abbd208b98808d60509b82b63e1e5c77bede412b | |
parent | 3e6cbdeda83c2955b9f40c6995c76cce49cb33d7 (diff) | |
parent | 661a6533a02081353ec3cd7898ca701393a4dd1b (diff) | |
download | MipsCPU-599b598ec51fe84d425f2d5ed3d18642c1285029.tar.gz MipsCPU-599b598ec51fe84d425f2d5ed3d18642c1285029.zip |
Merge branch 'master' of https://github.com/m8pple/arch2-2014-cw1
-rw-r--r-- | README.md | 18 |
1 files changed, 9 insertions, 9 deletions
@@ -44,31 +44,31 @@ you are that way inclined), containing the original directory structure and files, as well as the files that you have contributed. The two key things you will be adding are: - - src/<your_login>/mips_cpu.c or mips_cpu.cpp + - src/[your_login]/mips_cpu.c or mips_cpu.cpp - - src/<your_login>/test_mips.c or test_mips.cpp + - src/[your_login]/test_mips.c or test_mips.cpp The first part is the implementation of a mips simulator, and is essentially a library that implements the api found in include/mips_cpu.h. You can use C or C++, either is fine. If you want to split into multiple files, then feel free to do -so - anything which matches the pattern src/<your_login>/mips_cpu_*.c -or src/<your_login>/mips_cpu_*.cpp will also get compiled into +so - anything which matches the pattern src/[your_login]/mips_cpu_*.c +or src/[your_login]/mips_cpu_*.cpp will also get compiled into your library. The second part is the test suite which will drive your simulator and make it do things. This is a C or C++ program (so it will have a main function), and should be either -src/<your_login>/test_mips.c or src/<your_login>/test_mips.cpp. +src/[your_login]/test_mips.c or src/[your_login]/test_mips.cpp. Again, if you want to split into multiple files, anything -that matches the pattern src/<your_login>/test_mips_*.c or -src/<your_login>/test_mips_*.cpp will get compiled into +that matches the pattern src/[your_login]/test_mips_*.c or +src/[your_login]/test_mips_*.cpp will get compiled into your program. You can also add your own private header files (generally a good idea), which should be part of the submitted zip file, but they don't need to follow any specific pattern. However, -they should be completely located within the src/<your_login> +they should be completely located within the src/[your_login] directory or a sub-directory of it. Note that your simulator and your test suite are two different components, so do not rely on the specific behaviour of _your_ simulator, it should @@ -91,7 +91,7 @@ The directory structure should look like: | | +-mips_mem_ram.cpp | | +-mips_test_framework.cpp | | - | +-<your_login> # This is your private folder + | +-[your_login] # This is your private folder | | | +-mips_cpu.c or mips_cpu.cpp | +-mips_cpu_*.c or mips_cpu_*.cpp (if you want them) |