From 941099778b59da6b904c284e8a82affe4766124b Mon Sep 17 00:00:00 2001 From: Charles Date: Mon, 30 Mar 2020 22:27:16 +0200 Subject: Added doc --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 1b31543..4ab2ad4 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,11 @@ minishell project of school 42 >make test ``` +## Documentation + +Generate with `make doc` (clean with `make doc_clean`). +You can then read the man pages in ./doc/man or open ./doc/html/index.html in your browser. + ## TODO ### Mandatory @@ -26,7 +31,7 @@ minishell project of school 42 - [ ] `'` and `"` should work like in bash except for multiline commands - [ ] Redirections `<` `>` `>>` should work like in bash except for file descriptor aggregation - [ ] Pipes | should work like in bash -- [ ] Environment variables (`$` followed by characters) should work like in bash +- [ ] Environment variables (`$` followed by characters) should work like in bash - [ ] `$?` should work like in bash - [ ] `ctrl-C`, `ctrl-D` and `ctrl-\` should have the same result as in bash -- cgit