From f537af1964f5a8952c2c2b4b94b64ba4708f5b80 Mon Sep 17 00:00:00 2001 From: Remzi Arpaci-Dusseau Date: Sat, 16 Feb 2019 19:28:14 -0500 Subject: [PATCH] README for each test --- initial-utilities/wcat/README.md | 11 +++++++---- initial-utilities/wgrep/README.md | 24 ++++++++++++++++++++++++ initial-utilities/wunzip/README.md | 23 +++++++++++++++++++++++ initial-utilities/wzip/README.md | 23 +++++++++++++++++++++++ 4 files changed, 77 insertions(+), 4 deletions(-) create mode 100644 initial-utilities/wgrep/README.md create mode 100644 initial-utilities/wunzip/README.md create mode 100644 initial-utilities/wzip/README.md diff --git a/initial-utilities/wcat/README.md b/initial-utilities/wcat/README.md index f280132..ff0224e 100644 --- a/initial-utilities/wcat/README.md +++ b/initial-utilities/wcat/README.md @@ -1,6 +1,6 @@ In this directory, you should write the program `wcat.c` and compile it into -the binary `wcat`. +the binary `wcat` (e.g., `gcc -o wcat wcat.c -Wall -Werror`). After doing so, you can run the tests from this directory by running the `test-wcat.sh` script. If all goes well, you will see: @@ -17,8 +17,11 @@ test 7: passed prompt> ``` -`test-wcat.sh` is just a wrapper for the `run-tests.sh` script in the `tester` -directory of this repository. This program has a few options; see the relevant -README for details. +The `test-wcat.sh` script is just a wrapper for the `run-tests.sh` script in +the `tester` directory of this repository. This program has a few options; see +the relevant +[README](https://github.com/remzi-arpacidusseau/ostep-projects/blob/master/tester/README.md) +for details. + diff --git a/initial-utilities/wgrep/README.md b/initial-utilities/wgrep/README.md new file mode 100644 index 0000000..031b83b --- /dev/null +++ b/initial-utilities/wgrep/README.md @@ -0,0 +1,24 @@ + +In this directory, you should write the program `wgrep.c` and compile it into +the binary `wgrep` (e.g., `gcc -o wgrep wgrep.c -Wall -Werror`). + +After doing so, you can run the tests from this directory by running the +`test-wgrep.sh` script. If all goes well, you will see: + +```sh +prompt> ./test-wgrep.sh +test 1: passed +test 2: passed +test 3: passed +test 4: passed +test 5: passed +test 6: passed +test 7: passed +prompt> +``` + +The `test-wgrep.sh` script is just a wrapper for the `run-tests.sh` script in +the `tester` directory of this repository. This program has a few options; see +the relevant +[README](https://github.com/remzi-arpacidusseau/ostep-projects/blob/master/tester/README.md) +for details. diff --git a/initial-utilities/wunzip/README.md b/initial-utilities/wunzip/README.md new file mode 100644 index 0000000..2f86221 --- /dev/null +++ b/initial-utilities/wunzip/README.md @@ -0,0 +1,23 @@ + +In this directory, you should write the program `wunzip.c` and compile it into +the binary `wunzip` (e.g., `gcc -o wunzip wunzip.c -Wall -Werror`). + +After doing so, you can run the tests from this directory by running the +`test-wunzip.sh` script. If all goes well, you will see: + +```sh +prompt> ./test-wunzip.sh +test 1: passed +test 2: passed +test 3: passed +test 4: passed +test 5: passed +test 6: passed +prompt> +``` + +The `test-wunzip.sh` script is just a wrapper for the `run-tests.sh` script in +the `tester` directory of this repository. This program has a few options; see +the relevant +[README](https://github.com/remzi-arpacidusseau/ostep-projects/blob/master/tester/README.md) +for details. diff --git a/initial-utilities/wzip/README.md b/initial-utilities/wzip/README.md new file mode 100644 index 0000000..4cc731a --- /dev/null +++ b/initial-utilities/wzip/README.md @@ -0,0 +1,23 @@ + +In this directory, you should write the program `wzip.c` and compile it into +the binary `wzip` (e.g., `gcc -o wzip wzip.c -Wall -Werror`). + +After doing so, you can run the tests from this directory by running the +`test-wzip.sh` script. If all goes well, you will see: + +```sh +prompt> ./test-wzip.sh +test 1: passed +test 2: passed +test 3: passed +test 4: passed +test 5: passed +test 6: passed +prompt> +``` + +The `test-wzip.sh` script is just a wrapper for the `run-tests.sh` script in +the `tester` directory of this repository. This program has a few options; see +the relevant +[README](https://github.com/remzi-arpacidusseau/ostep-projects/blob/master/tester/README.md) +for details.