From a0f278b13a1347663fd9626322b30e7b87615a0d Mon Sep 17 00:00:00 2001 From: Charles Cabergs Date: Mon, 1 Mar 2021 14:39:47 +0100 Subject: Added custom test configuration --- docs/gettingstarted.rst.inc | 46 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 docs/gettingstarted.rst.inc (limited to 'docs/gettingstarted.rst.inc') diff --git a/docs/gettingstarted.rst.inc b/docs/gettingstarted.rst.inc new file mode 100644 index 0000000..f1dce9c --- /dev/null +++ b/docs/gettingstarted.rst.inc @@ -0,0 +1,46 @@ +Getting Started +--------------- + +Installation +++++++++++++ + +.. code-block:: + + $ pip3 install minishell-test + $ pip3 install --user minishell-test # if you don't have root access + +.. _compatibility: + +Compatibility ++++++++++++++ + +Your executable **must** support the ``-c`` option which allow to pass command as an argument. + +.. code-block:: + + $ bash -c 'echo bonjour je suis | cat -e' + bonjour he suis$ + $ ./minishell -c 'echo bonjour je suis | cat -e' + bonjour je suis$ + + +.. note:: + With this setup ``argv[2]`` is what you would usually get in ``line`` from ``get_next_line``. + +Usage ++++++ + +Run all the predefined tests: + +.. code-block:: + + $ cd + $ minishell_test + +.. warning:: + If you get ``command not found``, do either of those things: + + * Add ``~/.local/bin`` to your ``PATH`` environment variable. + * Run ``$ python3 -m minishell_test`` instead of ``$ minishell_test`` + +.. vim:ft=rst -- cgit