From c2ca0d297b8e067c5e315500fb2f35f50ff6af8a Mon Sep 17 00:00:00 2001
From: Charles Cabergs <me@cacharle.xyz>
Date: Fri, 26 Feb 2021 14:49:49 +0100
Subject: Added docs draft

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

(limited to 'docs/index.rst')

diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..109963f
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,94 @@
+minishell_test
+==============
+
+Test for 42 school's minishell project.
+
+.. .. image:: https://i.imgur.com/98xh2xY.gif
+
+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``
+
+
+Documentation
+-------------
+
+.. toctree::
+   :maxdepth: 2
+
+   config
+   options
+   developers
+
+
+.. code-block::
+
+    $ minishell_test --help
+
+The options are explained in more details in :ref:`options <options>`.
+
+
+Environement variables
+----------------------
+
+This test only gives the ``PATH`` and ``TERM`` environment variables to your minishell by default (see :ref:`config env`).
+
+You can test this quickly with the `-t` option (See :ref:`options try`).
+
+.. warning::
+    Please check that your project still work with those settings before creating an issue or messaging me on.
+
+Bonus
+-----
+
+See :ref:`config bonus`
+See :ref:`options bonus`
+
+Memory leaks
+------------
+
+See :ref:`options leaks`
+
+Linux
+-----
+
+It will try to convert to output/status code of ``bash`` on Linux to the one on Mac.
-- 
cgit