readme and requirements

README.md

@@ -9,7 +9,7 @@ The main goal of the program is to generate the result of the beta_reduction of
 ## Table of contents
 
 
-<!-- TOC -->- [the structures](#structures)<br />    - [what to install](#needs)<br />    - [how to install](#how)<br />    - [utilisation](#utilisation)<br />    - [parsing ](#parse)<br />    - [documentation](#docu)<br />    - [contribution](#contri)<br /> <!-- /TOC -->
+<!-- TOC -->- [the structures](#structures)<br />    - [what to install](#needs)<br />    - [how to install](#how)<br />    - [utilisation](#utilisation)<br />    - [parsing syntax ](#parse)<br />    - [documentation](#docu)<br />    - [contribution](#contri)<br /> <!-- /TOC -->
 
 ## structures <a name="structures"></a>
 
@@ -18,35 +18,25 @@ Variable: [VAR, name]<br />
 Abstraction: [ABS, input, output] input and output are also lambda terms<br />
 Application: [APP, first_Term, second_Term] first_term and second_term are also lambda terms<br />
 
-The png images are already created, to build the image of a lambda term we just have to concatenate the existing images and to colorate the alligators and eggs by random colors.
+The png images are already created, to build the image of a lambda term, we just have to concatenate the existing images and to colorate the alligators and eggs by random colors.
 
 ## What to install <a name="needs"></a>
 
+1. PIL library (to generate images)
+2. PYFIGLET library(to implement a new font)
+3. keyboard module (to get an enter char)
+4. shutil module (manipulate directories)
 
+## how to install <a name="how"></a>
 
+- To install the needed tools, you have to use the following command:<br />
+pip install requirements.txt
 
-
-- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
-
-```
-cd existing_repo
-git remote add origin https://gitlab.lis-lab.fr/benjamin.monmege/alligators-python.git
-git branch -M main
-git push -uf origin main
-```
-
-## Integrate with your tools
-
-- [ ] [Set up project integrations](https://gitlab.lis-lab.fr/benjamin.monmege/alligators-python/-/settings/integrations)
-
-## Collaborate with your team
-
-- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
-- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
-- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
+## utilisation <a name="utilisation"></a>
+The program is very simple to use, these are some advices once we run the code: <br />
+1. When you have to make a choice, click a button which is indicated, the code won't stop asking you to re-enter a choice until you press a right button.
+2. The lambda term that is given as an input has to respect some syntactic rules, you can find the rules in the section parsing syntax.
+3. When you choose an option in the menu, the images that could have been generated are stocked in a temporary directory which you are free to save or delete at the end.
 
 ## Test and Deploy
 

requirements.txt

+Pillow
 pyfiglet
 keyboard
+shutil
\ No newline at end of file