diff options
| author | Charles Cabergs <me@cacharle.xyz> | 2021-02-28 18:30:06 +0100 |
|---|---|---|
| committer | Charles Cabergs <me@cacharle.xyz> | 2021-02-28 18:30:52 +0100 |
| commit | 8b613be06c58b33892e9b6501621899fde8fa8df (patch) | |
| tree | 80f218a4522725cb4c8da7e172d446d712faf140 | |
| parent | ed231c21894da3520929fc385027d57bbe0485a2 (diff) | |
| download | minishell_test-8b613be06c58b33892e9b6501621899fde8fa8df.tar.gz minishell_test-8b613be06c58b33892e9b6501621899fde8fa8df.tar.bz2 minishell_test-8b613be06c58b33892e9b6501621899fde8fa8df.zip | |
Added manualy built README.md since github doesn't support reST include directive
| -rw-r--r-- | README.md | 47 | ||||
| -rw-r--r-- | docs/README.rst (renamed from README.rst) | 2 |
2 files changed, 48 insertions, 1 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` diff --git a/README.rst b/docs/README.rst index c593638..fc5c802 100644 --- a/README.rst +++ b/docs/README.rst @@ -18,4 +18,4 @@ Test for 42 school's minishell project. .. image:: https://i.imgur.com/98xh2xY.gif :alt: preview -.. include:: docs/gettingstarted.rst +.. include:: gettingstarted.rst |