diff options
| -rw-r--r-- | README.md | 39 | ||||
| -rw-r--r-- | docs/README.rst | 25 | ||||
| -rwxr-xr-x | docs/build-readme-md | 4 |
3 files changed, 51 insertions, 17 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). diff --git a/docs/README.rst b/docs/README.rst index fc5c802..f8a56e8 100644 --- a/docs/README.rst +++ b/docs/README.rst @@ -1,17 +1,17 @@ minishell_test ============== -.. image:: https://img.shields.io/pypi/pyversions/minishell-test - :alt: PyPI - Python Version - :target: https://pypi.org/project/minishell-test/ +.. |pypi-python-version| image:: https://img.shields.io/pypi/pyversions/minishell-test + :alt: PyPI - Python Version + :target: https://pypi.org/project/minishell-test/ +.. |documentation-build| image:: https://readthedocs.org/projects/minishell-test/badge/?version=latest + :alt: Documentation + :target: https://minishell-test.readthedocs.io +.. |travis-build| image:: https://api.travis-ci.com/cacharle/minishell_test.svg?branch=master + :alt: Build Status + :target: https://travis-ci.com/cacharle/minishell_test -.. image:: https://readthedocs.org/projects/minishell-test/badge/?version=latest - :alt: Documentation - :target: https://minishell-test.readthedocs.io - -.. image:: https://api.travis-ci.com/cacharle/minishell_test.svg?branch=master - :alt: Build Status - :target: https://travis-ci.com/cacharle/minishell_test +|pypi-python-version| |documentation-build| |travis-build| Test for 42 school's minishell project. @@ -19,3 +19,8 @@ Test for 42 school's minishell project. :alt: preview .. include:: gettingstarted.rst + +Documentation +------------- + +The full documentation for this project is available at `minishell-test.readthedocs.io<https://minishell-test.readthedocs.io>`_. diff --git a/docs/build-readme-md b/docs/build-readme-md new file mode 100755 index 0000000..256bf63 --- /dev/null +++ b/docs/build-readme-md @@ -0,0 +1,4 @@ +#!/bin/sh + +# gfm = github flavored markdown +pandoc README.rst -f rst -t gfm > ../README.md |