matcom · danielorlando97 · Mar 3, 2021 · Mar 4, 2021 · Mar 4, 2021 · Mar 16, 2021
diff --git a/.DS_Store b/.DS_Store
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
diff --git a/.gitignore b/.gitignore
diff --git a/.ipynb_checkpoints/cp1-checkpoint.ipynb b/.ipynb_checkpoints/cp1-checkpoint.ipynb
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,4 @@
+{
+    "python.pythonPath": "/home/dany/.cache/pypoetry/virtualenvs/cmp-Jp0snq0--py3.8/bin/python",
+    "jupyter.jupyterServerType": "remote"
+}
diff --git a/LICENSE b/LICENSE
diff --git a/Pipfile b/Pipfile
@@ -0,0 +1,12 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+sly = "*"
+
+[dev-packages]
+
+[requires]
+python_version = "3.9"
diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/Readme.md b/Readme.md
@@ -1,172 +1,43 @@
-# COOL: Proyecto de Compilación
+# ⚙️ Compiler for COOL language
+
+[![Tests](https://github.com/matcom-school/cool-compiler-2021/actions/workflows/tests.yml/badge.svg)](https://github.com/matcom-school/cool-compiler-2021/actions/workflows/tests.yml)
 
-> Proyecto base para el compilador de 4to año en Ciencia de la Computación.
 
-## Generalidades
+## 🤔 What's it?
 
-La evaluación de la asignatura Complementos de Compilación, inscrita en el programa del 4to año de la Licenciatura en Ciencia de la Computación de la Facultad de Matemática y Computación de la
-Universidad de La Habana, consiste este curso en la implementación de un compilador completamente
-funcional para el lenguaje _COOL_.
+Compiler for the COOL language, you can see its official documentation [here](https://github.com/matcom-school/cool-compiler-2021/tree/master/doc). 
+The COOL language is a static and strongly typed tool, with imperative syntax and influenced by 
+the object-oriented design pattern. In this project a compiler is developed that transforms 
+plain text code into executable [MIPS](https://www.google.com/url?sa=t&rct=j&q=&esrc=s&source=web&cd=&cad=rja&uact=8&ved=2ahUKEwjr4bytrL_7AhXZi7AFHVj3D-QQFnoECAoQAQ&url=https%3A%2F%2Fwww.mips.com%2F&usg=AOvVaw0pNYEgrs30qfMWUUI1txqH) 
+code. To perform this transformation, the system is 
+composed of 4 main modules that represent the 4 main phases of language theory 
+(lexer, parser, semantic checking and code generation). \
+**Principal Skills**: `Python` `Metaprogramming` `AST` `Visitor Pattern` `Sly` `MIPS`
 
-_COOL (Classroom Object-Oriented Language)_ es un pequeño lenguaje que puede ser implementado con un esfuerzo razonable en un semestre del curso. Aun así, _COOL_ mantiene muchas de las características de los lenguajes de programación modernos, incluyendo orientación a objetos, tipado estático y manejo automático de memoria.
+## 🤓 Motivation 
 
-## Cómo comenzar (o terminar)
+This project was developed as part of a compilation course at the University of Havana. 
+With the educational foundation of knowing the main aspects of a compiler or interpreter, 
+tools that developers use on a daily basis.
 
-El proyecto de Compilación será recogido y evaluado **únicamente** a través de Github. Es imprescindible tener una cuenta de Github para cada participante, y que su proyecto esté correctamente hosteado en esta plataforma. A continuación le damos las instrucciones mínimas necesarias para ello:
+## 🧐 How to use it?
 
-### 1. Si no lo han hecho ya, regístrense en [Github](https://github.com) todos los miembros del equipo (es gratis).
-
-![](img/img1.png)
-
-### 2. Haga click en el botón **Fork** para hacer una copia del proyecto en el perfil de Github de uno de los miembros.
-
-Opcionalmente pueden [crear una organización](https://github.com/organizations/new) y copiar el proyecto en el perfil de la misma.
-
-![](img/img2.png)
-
-### 3. Una vez hecho esto, tendrá un nuevo repositorio en `github/<usuario>`.
-
-Revise que el repositorio de su equipo está en su perfil.
-En este ejemplo se ha copiado a la cuenta de `github.com/apiad`.
-
-Debe indicar bajo el nombre del repositorio: `"forked from matcom/cool-compiler-2021"`.
-
-![](img/img3.png)
-
-### 4. Clone este proyecto en un repositorio local.
-
-Busque la URL de su proyecto en la interfaz web de Github.
-
-Asegúrese de clonar **su copia** y no el proyecto original en `matcom/cool-compiler-2021`.
-
-![](img/img4.png)
-
-```bash
-$ git clone git@github.com:<usuario>/cool-compiler-2021.git
-```
-
-> Donde `<usuario>` es posiblemente el nombre de su equipo o del miembro donde se hizo el _fork_.
-
-A partir de este punto debe tener un proyecto `cool-compiler-2021` local.
-El siguiente paso depende de si usted ya tiene su código versionado con `git` o no.
-
-### 5.A. Si tiene su proyecto en git (y no quiere perder la historia):
-
-#### 5.1. Mezcle hacia el nuevo respositorio su repositorio anterior:
+First download the project  
 
 ```bash
-$ cd cool-compiler-2021
-$ git pull --allow-unrelated-histories <my-old-compiler-project> master
-```
-
-#### 5.2. Organice su proyecto, código fuente y documentación, de acuerdo a las instrucciones de este documento, y vuelva a hacer `commit`.
-
-```bash
-$ mv <my-old-code> src/
-$ git add .
-$ git commit -a -m "Mezclado con el proyecto base"
-```
-
-#### 5.3. A partir de este punto puede hacer `push` cada vez que tenga cambios que subir.
-
-```bash
-$ git push origin master
+$ git clone https://github.com/matcom-school/cool-compiler-2021.git
+$ pip install -r requirements.txt
 ```
-
-### 5.B Si aún no tiene su proyecto en git (o no le importa la historia):
-
-#### 5.1. Simplemente copie el código de su proyecto en la carpeta correspondiente `src` y haga su primer commit.
+Check that all tests are working properly 
 
 ```bash
-$ mv <my-old-code> src/
-$ git commit -a -m "Hello Git!"
+$ cd src
+$ make test
 ```
 
-#### 5.2. A partir de este punto asegúrese de hacer `commit` de forma regular para mantener su repositorio actualizado.
-
-Si necesita saber más sobre `git`, todo lo imprescindible está en [esta guía](doc/github-git-cheat-sheet.pdf).
-
-#### 5.3. A partir de este punto puede hacer `push` cada vez que tenga cambios que subir.
+Then type your COOL code and save the changes in .cl and execute the following commands
 
 ```bash
-$ git push origin master
+$ make <name_file>.cl
 ```
 
-## Entregas
-
-En este proyecto se realizarán entregas parciales a lo largo del curso. Para realizar una entrega, siga los siguientes pasos.
-
-### 1. Cree un pull request al proyecto original desde su copia.
-
-![](img/img5.png)
-
-### 2. Asegúrese de tener la siguiente configuración antes de hacer click en **Create pull request**.
-
-- **base repository**: `matcom/cool-compiler-2021` (repositorio original)
-  - **branch**: `master`
-- **head repository**: `<usuario>/cool-compiler-2021` (repositorio propio)
-  - **branch**: `master` (o la que corresponda)
-
-> Asegúrese que se indica **Able to merge**. De lo contrario, existen cambios en el repositorio original que usted no tiene, y debe actualizarlos.
-
-> **NOTA**: Asegúrese que el _pull request_ se hace a la rama `master`.
-
-![](img/img6.png)
-
-### 3. Introduzca un título y descripción adecuados, y haga click en **Create pull request**.
-
-![](img/img7.png)
-
-### 4. Espere mientras se ejecutan las pruebas.
-
-Verá la indicación **Some checks haven't completed yet**.
-
-![](img/img8.png)
-
-Es posible que tenga que actualizar los cambios que se hayan hecho en el repositorio original, por ejemplo, si se han agregado nuevos tests. En este caso obtendrá el siguiente mensaje:
-
-> **This branch is out-of-date with base branch**
-
-Haga click en **Update branch** y siga las instrucciones.
-### 5. Verifique que no hubo errores en las pruebas.
-
-Si ve el mensaje **(All | Some) checks have failed**, significa que su código no pasó las pruebas.
-
-![](img/img9.png)
-
-Para ver los resultados de las pruebas haga click en el link **Details**.
-
-![](img/img10.png)
-
-
-### 6. Arregle los errores y repita el paso 5 hasta que todas las pruebas pasen.
-
-Para cualquier modificación que haga a su proyecto, haga _commit_ y _push_ para **su repositorio personal** y automáticamente se actualizará el estado del _pull request_ y se volverán a ejecutar las pruebas. **No es necesario** abrir un _pull request_ nuevo por cada entrega, sino actualizar el anterior.
-
-> **Por favor asegúrese de mantener un solo _pull request_ activo por equipo**. En caso de abrir uno nuevo, cerrar el anterior.
-
-## Sobre la implementación
-
-Ponga todo su código e instrucciones necesarias en la carpeta `src`. Más información en [`src/Readme.md`](src/Readme.md).
-
-## Sobre la documentación
-
-Usted debe presentar un reporte escrito documentando el proceso de construcción de su compilador y los detalles más importantes de su funcionamiento. Más información en [`doc/Readme.md`](doc/Readme.md).
-
-## Sobre los equipos de desarrollo
-
-Para desarrollar el compilador del lenguaje COOL se trabajará en equipos de 2 o 3 integrantes.
-
-## Sobre los casos de prueba
-
-La carpeta `tests` contiene todos los casos de prueba que son obligatorios de pasar para que su proyecto tenga derecho a ser evaluado.
-
-Estos tests se ejecutan automáticamente cada vez que hace un _pull request_ al repositorio `matcom/cool-compiler-2021`. Solo aquellos proyectos que pasen todas las pruebas con éxito serán evaluados.
-
-Para ejecutar las pruebas localmente, debe tener instalado `Python 3.7`, `pip` y `make` (normalmente viene con Linux). Ejecute:
-
-```bash
-$ pip install -r requirements.txt
-$ cd src
-$ make test
-```
diff --git a/doc/Readme.md b/doc/Readme.md