Construction of readme 1

Author: amauricoder

.vscode/c_cpp_properties.json

@@ -0,0 +1,34 @@
+# **************************************************************************** #
+#                                                                              #
+#                                                         :::      ::::::::    #
+#    LICENSE                                            :+:      :+:    :+:    #
+#                                                     +:+ +:+         +:+      #
+#    By: aconceic <[email protected]>          +#+  +:+       +#+         #
+#                                                 +#+#+#+#+#+   +#+            #
+#    Created: 2024/02/05 13:34:55 by aconceic          #+#    #+#              #
+#    Updated: 2024/11/04 17:08:31 by aconceic         ###   ########.fr        #
+#                                                                              #
+# **************************************************************************** #
+
+
+This is a free work delivered for educational purposes during the main course
+at 42 <42 Porto>.
+
+Feel free to use it, change it, give advices, send me a pull request or
+just slack me if you want to share some thoughts.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

.vscode/launch.json

@@ -1,2 +1,72 @@
 # 42_minishell
 Repository of the project minishell from 42 Porto.
+
+<!-- ![Banner](minishell.png "minishell banner") -->
+
+## Table of contents
+
+- [Sources and Acknowledgments](#sources-and-acknowledgments)
+- [Introduction](#introduction)
+- [Usage](#usage)
+- [Example of usage](#example-of-usage)
+
+## Sources and Acknowledgments
+I would like to share the key resources that helped me to construct this project. My sincere thanks go out to everyone who has shared their knowledge freely with the community.
+
+- [Minishell: Building a mini-bash](https://m4nnb3ll.medium.com/minishell-building-a-mini-bash-a-42-project-b55a10598218) - By [MannBell](https://m4nnb3ll.medium.com/)
+- [Shell Program Explained - Playlist](https://www.youtube.com/watch?v=ubt-UjcQUYg) - By [hhp3](https://www.youtube.com/@hhp3)
+- [What Happens When You Type a Command in Your Terminal](https://www.youtube.com/watch?v=2P7fcVHxA9o) - By [warpdotdev](https://www.youtube.com/@warpdotdev)
+- [Chapter 5. Writing Your Own Shell](https://www.cs.purdue.edu/homes/grr/SystemsProgrammingBook/Book/Chapter5-WritingYourOwnShell.pdf) - By  Gustavo Rodriguez-Rivera and Justin Ennen,Introduction to Systems Programming: a Hands-on Approach (V2015-2-25)
+(systemsprogrammingbook.com)
+- [Unix terminals and shells](https://www.youtube.com/playlist?list=PLFAC320731F539902) - By [Brian Will](https://www.youtube.com/@briantwill)
+- [Bash Reference Manual](https://www.gnu.org/software/bash/manual/bash.html) -  By Free Software Foundation, Inc
+- [Write a shell in C](https://brennan.io/2015/01/16/write-a-shell-in-c/) - By [Stephen Brennan](https://brennan.io/)
+
+And I would like to thank by peers from 42 Porto, who helped me a lot during all the process of this complex project. Thank you all. Sharing knowledge make us better.
+Special thanks to [Isabella Miranda](https://github.com/bellamiranda), my partner throughout this project, who co-constructed this minishell with me.
+
+---
+
+## Introduction
+
+This Project is about to recreate your own implementation of a shell based on bash shell.
+[What is a shell](https://www.datacamp.com/blog/what-is-shell?dc_referrer=https%3A%2F%2Fwww.google.com%2F)
+
+We needed to recreate some specifics behaviours of bash shell:
+- Display a prompt when waiting for a new command;
+- Have a working history.
+- Search and launch the right executable (based on the PATH variable or using a
+relative or an absolute path).
+- Implement redirections:
+- Implement pipes (| character) and Pipeline.
+- Handle environment variables ($ followed by a sequence of characters) which
+should expand to their values.
+- Handle $? which should expand to the exit status of the most recently executed
+foreground pipeline
+- Handle ctrl-C, ctrl-D and ctrl-\ which should behave like in bash.
+- Implements some builtins
+For the complete list of requiremets and limitations, read the [subject](subject/en.subject.pdf).
+
+---
+
+## Usage
+1 - In your terminal, clone the repository from github
+```
+	git clone [email protected]:amauricoder/42_minishell.git
+```
+
+2 - In your terminal, use 'make' to compile the project
+```
+	make
+```
+
+This will compile an executable program called minishell.
+3 - Execute ./minishell without any argument
+```
+	./minishell
+```
+
+## Example of Usage
+**Click on the image below to watch on Youtube an exaple of usage of this project**
+
+[![Watch the video](minishell.gif)](https://www.youtube.com/watch?v=urz76d7-Gq4)