Create README.md

README.md

@@ -0,0 +1,126 @@
+<div align=center>
+	<h1>
+		<i>Push_Swap</i>
+	</h1>
+	<img src="https://github.com/GiovannaCoqueiro/42cursus-push-swap/assets/115947494/6124a648-a0e1-40fa-a498-5af2e450b55d" alt=push_swap_badge/>
+	<p align=center>
+    		In this repository, you can accsess the code created for the Push Swap project, mandatory and bonus part.
+	</p>
+</div>
+
+---
+
+<div align=center>
+	<h2>
+		Final score
+	</h2>
+	<img src="https://github.com/GiovannaCoqueiro/42cursus-so-long/assets/115947494/fabaeaf5-3b12-46fc-af5c-104c03b28526" alt=push_swap_grade/>
+</div>
+
+---
+
+<h3 align=left>
+ Visual implementation of my algorithm:
+</h3>
+  <img src="https://github.com/GiovannaCoqueiro/42cursus-push-swap/blob/main/gif/sorting.gif" alt=algorithm_gif/>
+
+<h2>About</h2>
+
+<p>
+    This project involves creating a program to sort a list of numbers in ascending order using a set of predefined movements. The sorting process utilizes two stacks, Stack A and Stack B:
+</p>
+
+<ul>
+    <li><strong>Stack A:</strong> Initially holds the list of numbers that need to be sorted.</li>
+    <li><strong>Stack B:</strong> Starts empty and is used as an auxiliary stack during the sorting process.</li>
+</ul>
+
+<p>
+    The objective is to transfer the numbers from Stack A to Stack B using the defined operations to achieve a sorted sequence in ascending order.
+</p>
+
+<p>
+    The challenge lies in performing this sorting efficiently while adhering to the constraints and movement rules provided.
+</p>
+
+---
+
+#### Turk Algorithm
+
+The success of this project hinges on the Turk Algorithm, which was developed by [Ali Ogun](https://github.com/ayogun), another 42 student.
+You can find a detailed explanation of the algorithm in his article, ["Push Swap — A journey to find most efficient sorting algorithm"](https://medium.com/@ayogun/push-swap-c1f5d2d41e97).
+I highly recommend reading this article to gain a deeper understanding of how the algorithm works.
+
+---
+
+<h4 aling=left>
+  Allowed Operations:
+</h4>
+
+| Movement | How it works |
+| :---: | :--- |
+| pa | Take the first element at the top of B and put it at the top of A. Do nothing if B is empty. |
+| pb | Take the first element at the top of A and put it at the top of B. Do nothing if A is empty. |
+| sa | Swap the first 2 elements at the top of stack A. Do nothing if there is only one or no elements. |
+| sb | Swap the first 2 elements at the top of stack B. Do nothing if there is only one or no elements. |
+| ss | sa and sb at the same time. |
+| ra | Shift up all elements of stack A by 1. The first element becomes the last one. |
+| rb | Shift up all elements of stack B by 1. The first element becomes the last one. |
+| rr | ra and rb at the same time. |
+| rra | Shift down all elements of stack A by 1. The last element becomes the first one. |
+| rrb | Shift down all elements of stack B by 1. The last element becomes the first one. |
+| rrr | rra and rrb at the same time. |
+
+Run it with:
+```sh
+  $> ./push_swap <random_numbers>
+```
+
+<p>
+  It must display the list of instructions used to sort the list of numbers.
+</p>
+
+---
+
+<h3 align=left>
+    Bonus ⭐
+</h3>
+<p>
+	Consists in writing a checker program that verifies whether an unsorted list can be sorted using a given list of move instructions.
+</p>
+
+Run it with:
+```sh
+  $> ./checker <random_numbers>
+```
+
+<p>
+ You will need to input a list of move instructions for the program to execute and sort the numbers.
+  Each instruction should be on a new line. To complete your input, press "Ctrl+D".
+  <li>  If the instructions successfully sort the numbers, the program will display "OK".</li>
+  <li> If the instructions do not sort the numbers correctly, it will display "KO".</li>
+  <li> If you enter an invalid instruction or an incorrect list of numbers, the program will display "Error".</li>
+</p>
+
+---
+
+<h3>
+    Usage
+</h3>
+<p>
+Clone this repository in you local computer using a terminal:
+</p>
+
+```sh
+$> git clone git@github.com:AnaVolkmann/42_PUSH_SWAP.git
+```
+
+After cloning the project to your local repository, you can use the following commands from the Makefile:
+<ul>
+    <li> <b>make all:</b> or just <b>make</b> compiles the project</li>
+    <li><b>make clean:</b> deletes the object files created during compilation</li>
+    <li><b>make fclean:</b> executes the <b>clean</b> command and also deletes the binary files</li>
+    <li> <b>make re:</b> runs the <b>fclean</b> command followed by <b>make all</b> to recompile the project</li>
+    <li> <b>make bonus:</b> compiles the project with bonus features (if applicable)</li>
+    <li> <b>make rebonus:</b> runs the <b>fclean</b> command followed by <b>make bonus</b> to recompile with bonus features</li>
+</ul>