diff --git a/README.md b/README.md index 40e1fdf817fd421a56c91e729e94713fadf8aa54..08c03886e7ea67c4b903a1ced156b8fd1beff124 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,33 @@ -## Getting started +## About the project + +The main goal of the program is to generate the result of the beta_reduction of a lambda term given as an input and to show the images of the alligator's families that represents the lambda term and the different steps of it's beta_reduction. It also allows us to see how logical, boolean and arithmetic expressions are written in lambda calculus. + +## Table of contents +1. [ The structures. ] (#structures) +2. [ What to install. ] (#needs) +3. [ How to install. ] (#installations) +4. [ Utilisation. ] (#utilisation) +5. [ parsing syntax. ] (#allow) +6. [ Documentation. ] (#Docu) +7. [ Contribution. ] (#cont) + +## The structures <a name="structures"></a> + +Lambda terms are respresented by lists, the first element of the list is an indication to the type of the lambda term that it represents. +Variable: [VAR, name], +Abstraction: [ABS, input, output] input and output are also lambda terms +Application: [APP, first_Term, second_Term] first_term and second_term are also lambda terms + +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> + -To make it easy for you to get started with GitLab, here's a list of recommended next steps. -Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)! -## Add your files - [ ] [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: