Skip to content

Commit ca388e7

Browse files
committed
Update README.md to reflect changes to workflow
Now that we must use C++ 14 or newer, the documentation should reflect that. I also added that you can run the executable using `./foo_tests` because I am not sure it's obvious.
1 parent 6c62ae2 commit ca388e7

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ the implementation of the function listed in `foo.h`.
9999
To compile the test code use the following:
100100

101101
```bash
102-
g++ -Wall -g -o foo_test foo.c foo_test.cpp -lgtest -pthread -std=c++0x
102+
g++ -Wall -g -o foo_test foo.c foo_test.cpp -lgtest -pthread -std=c++14
103103
```
104104

105105
*Notice that this uses `g++` instead of `gcc`.* This because the `gtest`
@@ -110,7 +110,8 @@ the executable, however, which can be *extremely* helpful when using
110110
tools like `valgrind` or the `gdb` debugger. If you don't include it,
111111
for example, then those tools won't be able to report accurate or useful
112112
line numbers or function names. The `-lgtest` tells the compiler to include
113-
the `gtest` library (that's the `-l` part) when generating the executable.
113+
the `gtest` library (that's the `-l` part) when generating the executable
114+
`foo_test`, which you can run using `./foo_test`.
114115

115116
---
116117

@@ -238,10 +239,10 @@ You can use references like `../mergesort/mergesort.h` or
238239
`../mergesort/mergesort.c` to access appropriate files in that part of
239240
the project, either in things like `#include` statements or
240241
in `gcc/g++` calls. The command in the GitHub Actions to compile
241-
the Array Merge tess, for example, is:
242+
the Array Merge tests, for example, is:
242243

243244
```text
244-
g++ -Wall -g -o array_merge_test ../mergesort/mergesort.c array_merge.c array_merge_test.cpp -lgtest -pthread -std=c++0x
245+
g++ -Wall -g -o array_merge_test ../mergesort/mergesort.c array_merge.c array_merge_test.cpp -lgtest -pthread -std=c++14
245246
```
246247

247248
Note that the `../mergesort/mergesort.c` in this command includes
@@ -258,6 +259,6 @@ That has two major implications:
258259

259260
Be sure that:
260261

261-
- [ ] You follow our instructions
262+
- [ ] You follow our instructions (especially about how we want you to be using `malloc` or `calloc` instead of leveraging the dynamically allocated memory option)
262263
- [ ] Your canvas group matches your github classroom group
263-
- [ ] You submit your repository URL to canvas (if your canvas groups are set up correctly this will only need to be done once)
264+
- [ ] You submit your repository URL to canvas (if your canvas groups are set up correctly this will only need to be done by one team member)

0 commit comments

Comments
 (0)