From 8b613be06c58b33892e9b6501621899fde8fa8df Mon Sep 17 00:00:00 2001
From: Charles Cabergs <me@cacharle.xyz>
Date: Sun, 28 Feb 2021 18:30:06 +0100
Subject: Added manualy built README.md since github doesn't support reST
 include directive

---
 README.md       | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 README.rst      | 21 ---------------------
 docs/README.rst | 21 +++++++++++++++++++++
 3 files changed, 68 insertions(+), 21 deletions(-)
 create mode 100644 README.md
 delete mode 100644 README.rst
 create mode 100644 docs/README.rst

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7ca51ef
--- /dev/null
+++ b/README.md
@@ -0,0 +1,47 @@
+# minishell_test
+
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/minishell-test)](https://pypi.org/project/minishell-test/)
+[![Documentation](https://readthedocs.org/projects/minishell-test/badge/?version=latest)](https://minishell-test.readthedocs.io)
+[![Build Status](https://api.travis-ci.com/cacharle/minishell_test.svg?branch=master)](https://travis-ci.com/cacharle/minishell_test)
+
+Test for 42 school\'s minishell project.
+
+![preview](https://i.imgur.com/98xh2xY.gif)
+
+## Getting Started
+
+### Installation
+
+``` {.}
+$ 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.
+
+``` {.}
+$ bash -c 'echo bonjour je suis | cat -e'
+bonjour je suis$
+$ ./minishell -c 'echo bonjour je suis | cat -e'
+bonjour je suis$
+```
+
+With this setup `argv[2]` is what you would usually get in `line` from
+`get_next_line`.
+
+### Usage
+
+Run all the predefined tests:
+
+``` {.}
+$ cd <MINISHELL>
+$ minishell_test
+```
+
+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`
diff --git a/README.rst b/README.rst
deleted file mode 100644
index c593638..0000000
--- a/README.rst
+++ /dev/null
@@ -1,21 +0,0 @@
-minishell_test
-==============
-
-.. image:: https://img.shields.io/pypi/pyversions/minishell-test
-   :alt: PyPI - Python Version
-   :target: https://pypi.org/project/minishell-test/
-
-.. image:: https://readthedocs.org/projects/minishell-test/badge/?version=latest
-   :alt: Documentation
-   :target: https://minishell-test.readthedocs.io
-
-.. image:: https://api.travis-ci.com/cacharle/minishell_test.svg?branch=master
-   :alt: Build Status
-   :target: https://travis-ci.com/cacharle/minishell_test
-
-Test for 42 school's minishell project.
-
-.. image:: https://i.imgur.com/98xh2xY.gif
-   :alt: preview
-
-.. include:: docs/gettingstarted.rst
diff --git a/docs/README.rst b/docs/README.rst
new file mode 100644
index 0000000..fc5c802
--- /dev/null
+++ b/docs/README.rst
@@ -0,0 +1,21 @@
+minishell_test
+==============
+
+.. image:: https://img.shields.io/pypi/pyversions/minishell-test
+   :alt: PyPI - Python Version
+   :target: https://pypi.org/project/minishell-test/
+
+.. image:: https://readthedocs.org/projects/minishell-test/badge/?version=latest
+   :alt: Documentation
+   :target: https://minishell-test.readthedocs.io
+
+.. image:: https://api.travis-ci.com/cacharle/minishell_test.svg?branch=master
+   :alt: Build Status
+   :target: https://travis-ci.com/cacharle/minishell_test
+
+Test for 42 school's minishell project.
+
+.. image:: https://i.imgur.com/98xh2xY.gif
+   :alt: preview
+
+.. include:: gettingstarted.rst
-- 
cgit