aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorCharles Cabergs <me@cacharle.xyz>2020-11-06 13:47:18 +0100
committerCharles Cabergs <me@cacharle.xyz>2020-11-06 13:47:18 +0100
commitada1b5081a04bbe3c2304422fb63301abeeabfaf (patch)
treecb0075e5b1da670b7249fa6cf53b658cf6678c96 /README.md
parentd3ea6e61b70bf6bf8173f35ce0b3abbd264f24aa (diff)
downloadminishell_test-ada1b5081a04bbe3c2304422fb63301abeeabfaf.tar.gz
minishell_test-ada1b5081a04bbe3c2304422fb63301abeeabfaf.tar.bz2
minishell_test-ada1b5081a04bbe3c2304422fb63301abeeabfaf.zip
Added environment variable explaination in README
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
index dc37b49..e8c01d5 100644
--- a/README.md
+++ b/README.md
@@ -68,6 +68,23 @@ This allows you to set the prompt to whatever you want.
This test works with python >= 3.5.
+### Environement variables
+
+My test only gives the `PATH=minishell_test/bin` and `TERM=xterm-256color` variables to your minishell.
+**Please check that your project still work with those settings before messaging me on Slack or creating an issue**.
+
+You can test this quickly in a python script:
+
+```python
+import subprocess
+p = subprocess.run(
+ ["./minishell", "-c", "<INPUT>"],
+ capture_output=True,
+ env={"PATH": "minishell_test/bin", "TERM": "xterm-256color"}
+)
+print(p.stdout.decode())
+```
+
## Bonus
Their is 3 different method to enable the bonus tests: