From 6100010d6873845413aed22744470616992df603 Mon Sep 17 00:00:00 2001
From: Charles Cabergs <me@cacharle.xyz>
Date: Mon, 5 Oct 2020 14:04:41 +0200
Subject: Readded should be dead test

---
 README.md | 27 +++++++++++++++++++++++----
 1 file changed, 23 insertions(+), 4 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 43ca107..13268b3 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,8 @@ Test for the philosophers project of school 42.
 
 ## Usage
 
-Clone this repository next to your project directory. (or change the default path in the config)
+Clone this repository next to your project directory.
+(or change the default path in the [config](src/config.py))
 
 ```
 .
@@ -14,14 +15,32 @@ Clone this repository next to your project directory. (or change the default pat
 
 ```
 $ ./run --help
-usage: run [-h] -p {1,2,3} [-b] [-g]
+usage: run [-h] -p {0,1,2,3} [-b] [-g] [-t TIMEOUT]
 
 Philosophers test
 
 optional arguments:
   -h, --help            show this help message and exit
-  -p {1,2,3}, --philo {1,2,3}
-                        Id of the philosophers to test
+  -p {0,1,2,3}, --philo {0,1,2,3}
+                        Number of the philosopher program to test
+                         - 1: philo_one
+                         - 2: philo_two
+                         - 3: philo_three
+                         - 0: all programs
   -b, --build           Build and exit
   -g, --pager           Open result.log in a pager after the test
+  -t TIMEOUT, --timeout TIMEOUT
+                        Change the philosopher process time (in seconds)
+
+Tested:
+ - Take 2 forks before eating
+ - State switch in the correct order
+   think -> fork -> fork -> eat n times -> sleep
+ - Almost 0 delay between second fork taken and eat
+ - Die if the death timeout is expired
+ - No output after death
+ - Timestamp in order
+ - Only take existing fork
+ - Error message and status != 0 on argument error
+   (not asked by subject but easy to do and cleanner)
 ```
-- 
cgit