diff --git a/README.md b/README.md new file mode 100644 index 0000000..f390d7d --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +# Minishell +## Our 42 minishell repo + +## About + +The minishell project was part of our curriculum at the 42Vienna programming school. +This project is considered a milestone, and is a great jump in complexity from the previous assignments. +Here you can find our implementation. + +## Features + +- Executing command line arguments +- Built-in functionality (cd, echo, export, exit etc.) +- Environment Variables +- Command history +- Logical operators AND ( && ), OR ( || ) +- Wildcards operators (*) +- Heredoc +- Output redirection +- and more + +The project is written in C for the GNU/Linux platform, using mostly self implemented tools, only relying on syscalls +for interfacing with the OS. + +## Setup +To compile the program, simply run +``` +make +``` +The binary can then be found in the bin directory and run directly + +## Credits + +We created this project as team with my teammate [Andrej](github.com/zekmaro). +Big thanks to him for implementing a lot of the functionality.