diff options
Diffstat (limited to 'docs/gettingstarted.rst')
| -rw-r--r-- | docs/gettingstarted.rst | 42 |
1 files changed, 0 insertions, 42 deletions
diff --git a/docs/gettingstarted.rst b/docs/gettingstarted.rst deleted file mode 100644 index 15c1efc..0000000 --- a/docs/gettingstarted.rst +++ /dev/null @@ -1,42 +0,0 @@ -Getting Started ---------------- - -Installation -++++++++++++ - -.. code-block:: - - $ 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 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> - $ 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`` |