From ed231c21894da3520929fc385027d57bbe0485a2 Mon Sep 17 00:00:00 2001
From: Charles Cabergs <me@cacharle.xyz>
Date: Sun, 28 Feb 2021 18:22:56 +0100
Subject: Merging common content between README.rst and index.rst in
 gettingstarted.rst

---
 docs/gettingstarted.rst | 42 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)
 create mode 100644 docs/gettingstarted.rst

(limited to 'docs/gettingstarted.rst')

diff --git a/docs/gettingstarted.rst b/docs/gettingstarted.rst
new file mode 100644
index 0000000..e45ff38
--- /dev/null
+++ b/docs/gettingstarted.rst
@@ -0,0 +1,42 @@
+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 string.
+
+.. 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:
+
+    * ``~/.local/bin`` to your ``PATH`` environment variable.
+    * run ``$ python3 -m minishell_test`` instead of ``$ minishell_test``
-- 
cgit