add detail on how to run tests at top of README

This commit is contained in:
Remzi Arpaci-Dusseau
2019-03-01 05:23:57 -06:00
parent dba96f7a4c
commit 07aba47e94

View File

@@ -10,9 +10,30 @@ Also (increasingly) available are some tests to see if your code works; eventual
every project will have a set of tests available. The testing framework that is every project will have a set of tests available. The testing framework that is
currently available is found [here](https://github.com/remzi-arpacidusseau/ostep-projects/tree/master/tester). currently available is found [here](https://github.com/remzi-arpacidusseau/ostep-projects/tree/master/tester).
A specific testing script, found in each project directory, can be used to run A specific testing script, found in each project directory, can be used to run
the tests against your code. For example, in the initial utilities project, the the tests against your code.
relatively simple `wcat` program that you create can be tested by running the
`test-wcat.sh` script. For example, in the initial utilities project, the relatively simple `wcat`
program that you create can be tested by running the `test-wcat.sh` script.
This could be accomplished by the following commands:
```sh
prompt> git clone https://github.com/remzi-arpacidusseau/ostep-projects
prompt> cd ostep-projects/initial-utilities/wcat
prompt> emacs -nw wcat.c
prompt> gcc -o wcat wcat.c -Wall
prompt> ./test-wcat.sh
test 1: passed
test 2: passed
test 3: passed
test 4: passed
test 5: passed
test 6: passed
test 7: passed
prompt>
```
Of course, this sequence assumes (a) you use `emacs` (you should!), (b) your
code is written in one shot (impressive!), and (c) that it works perfectly
(well done!). Even for simple assignments, it is likely that the
compile/run/debug cycle might take a few iterations.
## C/Linux Projects ## C/Linux Projects