diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 39 |
1 files changed, 32 insertions, 7 deletions
@@ -1,10 +1,10 @@ -# minishell_test +# 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. +Test for 42 school's minishell project.  @@ -12,7 +12,7 @@ Test for 42 school\'s minishell project. ### Installation -``` {.} +``` $ pip3 install minishell-test $ pip3 install --user minishell-test # if you don't have root access ``` @@ -22,26 +22,51 @@ $ pip3 install --user minishell-test # if you don't have root access 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$ ``` +<div class="note"> + +<div class="title"> + +Note + +</div> + With this setup `argv[2]` is what you would usually get in `line` from `get_next_line`. +</div> + ### Usage Run all the predefined tests: -``` {.} +``` $ cd <MINISHELL> $ minishell_test ``` +<div class="warning"> + +<div class="title"> + +Warning + +</div> + 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` +- `~/.local/bin` to your `PATH` environment variable. +- run `$ python3 -m minishell_test` instead of `$ minishell_test` + +</div> + +## Documentation + +The full documentation for this project is available at +[minishell-test.readthedocs.io](https://minishell-test.readthedocs.io). |