aboutsummaryrefslogtreecommitdiff
path: root/docs/gettingstarted.rst
diff options
context:
space:
mode:
authorCharles Cabergs <me@cacharle.xyz>2021-03-01 12:39:52 +0100
committerCharles Cabergs <me@cacharle.xyz>2021-03-01 12:39:52 +0100
commit2ae77423200364d3fb6c1823e4ddfb7542c834fb (patch)
tree4109daa4b22e5febc7a844042bebfcda36208bf2 /docs/gettingstarted.rst
parent072ec79b51cb4af45b168bf6f73941d1de94c8ae (diff)
downloadminishell_test-2ae77423200364d3fb6c1823e4ddfb7542c834fb.tar.gz
minishell_test-2ae77423200364d3fb6c1823e4ddfb7542c834fb.tar.bz2
minishell_test-2ae77423200364d3fb6c1823e4ddfb7542c834fb.zip
Added bonus doc, Updated command line options doc
Diffstat (limited to 'docs/gettingstarted.rst')
-rw-r--r--docs/gettingstarted.rst8
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/gettingstarted.rst b/docs/gettingstarted.rst
index e45ff38..15c1efc 100644
--- a/docs/gettingstarted.rst
+++ b/docs/gettingstarted.rst
@@ -12,12 +12,12 @@ Installation
Compatibility
+++++++++++++
-Your executable **must** support the ``-c`` option which allow to pass command as string.
+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$
+ bonjour he suis$
$ ./minishell -c 'echo bonjour je suis | cat -e'
bonjour je suis$
@@ -38,5 +38,5 @@ Run all the predefined tests:
.. warning::
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``
+ * Add ``~/.local/bin`` to your ``PATH`` environment variable.
+ * Run ``$ python3 -m minishell_test`` instead of ``$ minishell_test``