aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorCharles Cabergs <me@cacharle.xyz>2020-10-09 11:19:58 +0200
committerCharles Cabergs <me@cacharle.xyz>2020-10-09 11:19:58 +0200
commit84b23010e0d0515ad3ed17a605440e50439781e8 (patch)
tree2c71f2d4afbb7b0a8e9e128f1d1383f5637de88c /README.md
parent5d1410a9b08eb8df82a43312b8b6d3d9c1c9eb00 (diff)
downloadminishell_test-84b23010e0d0515ad3ed17a605440e50439781e8.tar.gz
minishell_test-84b23010e0d0515ad3ed17a605440e50439781e8.tar.bz2
minishell_test-84b23010e0d0515ad3ed17a605440e50439781e8.zip
Formatting/Refactoring, Added pretty ascii art
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 22 insertions, 8 deletions
diff --git a/README.md b/README.md
index 9e15bae..e788d48 100644
--- a/README.md
+++ b/README.md
@@ -16,17 +16,21 @@ usage: run [-h] [-k] [-x] [-r BEGIN END] [--show-range] [-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
- -k, --check-leaks Run valgrind on tests (disable usual comparison with
- bash)
+ -k, --check-leaks Run valgrind on tests (disable usual comparison with bash)
-x, --exit-first Exit on first fail
-r BEGIN END, --range BEGIN END
Range of test index to run (imply --show-index)
@@ -36,8 +40,11 @@ optional arguments:
-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
+ -p, --pager After running the test, display the result in a pager of your choice
+
+Signal handling is not tested
+There is a commented glob suite in src/suites/preprocess.py.
+Good luck handling `*'.*'`.
```
## Test compatibility
@@ -123,3 +130,10 @@ def suite_yoursuitename(test):
test(...)
test(...)
```
+
+---
+
+## Wildcard (or glob)
+
+There is a commented glob suite in [src/suites/preprocess.py](src/suites/preprocess.py).
+Good luck handling `*'.*'`.