diff --git a/README.md b/README.md index b099782..f8333ce 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,33 @@ # minishell + minishell project from 42 school -Download all: git clone --recursive https://github.com/jdomingu98/minishell.git +## Install + +Download repository including the libft submodule: +``` + git clone --recursive https://github.com/jdomingu98/minishell.git +``` + +or: + +``` + git clone https://github.com/jdomingu98/minishell.git + git submodule update --init --recursive +``` + +## Compilation + +To compile the project, execute ```cd``` into the cloned repository and use: + +``` + make +``` + +## Run program + + To run the program: + +``` + ./minishell +``` \ No newline at end of file