diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..7ca51ef --- /dev/null +++ b/README.md @@ -0,0 +1,47 @@ +# minishell_test + +[](https://pypi.org/project/minishell-test/) +[](https://minishell-test.readthedocs.io) +[](https://travis-ci.com/cacharle/minishell_test) + +Test for 42 school\'s minishell project. + + + +## Getting Started + +### Installation + +``` {.} +$ pip3 install minishell-test +$ pip3 install --user minishell-test # if you don't have root access +``` + +### Compatibility + +Your executable **must** support the `-c` option which allow to pass +command as string. + +``` {.} +$ bash -c 'echo bonjour je suis | cat -e' +bonjour je suis$ +$ ./minishell -c 'echo bonjour je suis | cat -e' +bonjour je suis$ +``` + +With this setup `argv[2]` is what you would usually get in `line` from +`get_next_line`. + +### Usage + +Run all the predefined tests: + +``` {.} +$ cd <MINISHELL> +$ minishell_test +``` + +If you get `command not found`, do either of those things: + +- `~/.local/bin` to your `PATH` environment variable. +- run `$ python3 -m minishell_test` instead of `$ minishell_test` |