aboutsummaryrefslogtreecommitdiff
path: root/docs/gettingstarted.rst.inc
blob: 1293f666c91c3cdbac1c3ba56183483281dc9b66 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
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 je 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``

.. vim:ft=rst