Added memory leak checking

1 files changed, 20 insertions, 12 deletions

diff --git a/README.md b/README.md
index 5c173ae..27b3644 100644
--- a/README.md
+++ b/README.md
@@ -11,24 +11,28 @@ The default path to your project is `..` but you can change it the the [configur
 ```sh
 $ ./run  # run all tests
 
-$ ./run --help
-usage: run [-h] [-v] [-b] [-n] [-l] [-m] [-p] [suite [suite ...]]
+$❯ ./run -h
+usage: run [-h] [-k] [-x] [-v] [-b] [-n] [-l] [-m] [-p] [suite [suite ...]]
 
 Minishell test
 
 positional arguments:
-  suite           Test suites/group to run.
-                  It tries to be smart and autocomplete the suite name
-                  (e.g ./run int -> ./run preprocess/interpolation)
+  suite              Test suites/group to run. It tries to be smart and
+                     autocomplete the suite name (e.g ./run int -> ./run
+                     preprocess/interpolation)
 
 optional arguments:
-  -h, --help      show this help message and exit
-  -v, --verbose   Increase verbosity level (e.g -vv == 2)
-  -b, --bonus     Enable bonus tests
-  -n, --no-bonus  Disable bonus tests
-  -l, --list      Print available test suites
-  -m, --make      Make minishell and exit
-  -p, --pager     After running the test, display the result in a pager of your choice
+  -h, --help         show this help message and exit
+  -k, --check-leaks  Run valgrind on tests (disable usual comparison with
+                     bash)
+  -x, --exit-first   Exit on first fail
+  -v, --verbose      Increase verbosity level (e.g -vv == 2)
+  -b, --bonus        Enable bonus tests
+  -n, --no-bonus     Disable bonus tests
+  -l, --list         Print available test suites
+  -m, --make         Make minishell and exit
+  -p, --pager        After running the test, display the result in a pager of
+                     your choice ./run --help
 ```
 
 ## Test compatibility
@@ -60,6 +64,10 @@ Their is 3 different method to enable the bonus tests:
 * Set the environment variable `MINISHELL_TEST_BONUS` to `yes`  
   (e.g `echo 'export MINISHELL_TEST_BONUS=yes' >> ~/.zshrc`)
 
+## Memory leaks
+
+`./run -kx`
+
 ## Linux
 
 The tester will try to convert to output/status code of bash on Linux to the one on Mac.