aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: cea6844358015a0b1c41e1f8be5f04b9b60b2370 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# minishell [![forthebadge](https://forthebadge.com/images/badges/just-plain-nasty.svg)](https://forthebadge.com)

minishell project of school 42.

## Authors

* [nahaddac](https://github.com/nass1pro)
* [cacharle](https://github.com/cacharle)

## Usage

```sh
$ make
$ ./minishell
```

## Testing

Done with [minishell\_test](https://github.com/cacharle/minishell_test).

```sh
$ git submodule update minishell_test
$ cd minishell_test
$ ./run --help
$ ./run
```

## Documentation

Install [Doxygen](https://www.doxygen.nl/index.html)
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.