aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorm8pple <dt10@imperial.ac.uk>2014-10-20 11:51:47 +0100
committerm8pple <dt10@imperial.ac.uk>2014-10-20 11:51:47 +0100
commit661a6533a02081353ec3cd7898ca701393a4dd1b (patch)
treee9d86da7edbaf29aeb89d86f5511c71a2374a2dc /README.md
parentfcf1520d54bf62fd419ace371f11e86815503428 (diff)
downloadMipsCPU-661a6533a02081353ec3cd7898ca701393a4dd1b.tar.gz
MipsCPU-661a6533a02081353ec3cd7898ca701393a4dd1b.zip
Modified for markdown rendering
Fixed #2 : replace <your_login> with [your_login]
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 9 insertions, 9 deletions
diff --git a/README.md b/README.md
index c62e2e7..533faab 100644
--- a/README.md
+++ b/README.md
@@ -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)