aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDominik Kaiser2025-11-12 21:10:45 +0100
committerGitHub2025-11-12 21:10:45 +0100
commit51c20abb725ebf12bb038759e67f7f726c9d03ff (patch)
tree6a4389abd69ad10e8b7191766df8630964f3dc9e
parent851968359252a8ef189e58c9ab80ad2caa0f714c (diff)
downloadminishell-51c20abb725ebf12bb038759e67f7f726c9d03ff.tar.gz
minishell-51c20abb725ebf12bb038759e67f7f726c9d03ff.zip
Add README HEADmain
-rw-r--r--README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..15688e8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# Minishell
+A partial reimplementation of bash from scratch created at 42 Heilbronn
+
+## Features
+- Command history
+- Pipes
+- File redirections and heredoc
+- Environment variables
+- Access to executables in path (`ls`, `cat`, `grep`, ...)
+- Complex string handling
+- Keyboard interupts (Ctrl-D, Ctrl-C, Ctrl-\\)
+- Shell nesting
+- Builtin commands
+ - echo
+ - export
+ - unset
+ - exit
+ - cd
+ - env
+ - pwd
+
+## Dependencies
+- gcc
+- GNU Make
+- readline
+## How to run this
+```bash
+# Clone the repo
+git clone https://github.com/dkaisr/minishell.git
+cd minishell
+make
+./minishell
+```