aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorCharles Cabergs <me@cacharle.xyz>2020-09-10 15:07:30 +0200
committerCharles Cabergs <me@cacharle.xyz>2020-09-10 15:07:30 +0200
commitc0b1a90cf9c52a0c9b1623ac695516031d5ccdba (patch)
treeb286ff19de9e57eb1948f751072f09dc3e79f8fc /README.md
parent2de1bf6e7dbda85ca3bb4ad77edac611a04b1ae3 (diff)
downloadminishell_test-c0b1a90cf9c52a0c9b1623ac695516031d5ccdba.tar.gz
minishell_test-c0b1a90cf9c52a0c9b1623ac695516031d5ccdba.tar.bz2
minishell_test-c0b1a90cf9c52a0c9b1623ac695516031d5ccdba.zip
Updated README, Added auto build
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 12 insertions, 10 deletions
diff --git a/README.md b/README.md
index 5c07be3..bacd967 100644
--- a/README.md
+++ b/README.md
@@ -4,12 +4,12 @@ Test for the minishell project of school 42.
![screenshot](./screenshot.png)
-# Usage
+## Usage
The default path to your project is `..` but you can change it the the [configuration](config.py).
-* `> ./main.py --help`
-* `> ./main.py`
+* `> ./run --help`
+* `> ./run`
## Test compatibility
@@ -27,17 +27,19 @@ README.md test.sh
README.md test.sh
```
-The reasons for this:
-1. You're free to set the prompt to whatever you want
-2. Termcaps would be a nightmare to test
+This allows you to set the prompt to whatever you want.
-# Configuration
+## Python Version
+
+This test works with python >= 3.4. The timeout detection only works with python >= 3.8.
+
+## Configuration
The default configuration can be changed in [config.py](config.py)
-# Add new tests
+## Add new tests
-## Add individual test
+### Add individual test
In your suite function you can use the `test` function. With the following arguments:
@@ -55,7 +57,7 @@ test("cat < somefile > otherfile",
files=["otherfile"])
```
-## Add Suite
+### Add Suite
A test suite is a group of related tests.