Added manualy built README.md since github doesn't support reST include directive

1 files changed, 47 insertions, 0 deletions

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`