matcom · sheycc · May 7, 2021 · Nov 1, 2021 · Nov 2, 2021 · Feb 26, 2022
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
diff --git a/.gitignore b/.gitignore
@@ -408,3 +408,4 @@ dmypy.json
 
 # Custom rules (everything added below won't be overriden by 'Generate .gitignore File' if you use 'Update' option)
 
+/venv
diff --git a/LICENSE b/LICENSE
diff --git a/Readme.md b/Readme.md
diff --git a/doc/Intro_ply.pdf b/doc/Intro_ply.pdf
diff --git a/doc/Readme.md b/doc/Readme.md
@@ -1,33 +1,40 @@
 # Documentación
 
-## Readme
+**Nombre** | **Grupo** | **Github**
+--|--|--
+Laura Brito Guerrero | C412 | [@LauryGirl](https://github.com/LauryGirl)
+Sheyla Cruz Castro | C412 | [@sheycc](https://github.com/sheycc)
+Ariel Antonio Huerta Martín | C412 | [@huertaariel1](https://github.com/huertaariel1)
 
-Modifique el contenido de este documento para documentar de forma clara y concisa los siguientes aspectos:
+# Uso del compilador
 
-- Cómo ejecutar (y compilar si es necesario) su compilador.
-- Requisitos adicionales, dependencias, configuración, etc.
-- Opciones adicionales que tenga su compilador.
+Para utilizar el compilador es necesario instalar todas las dependencias utilizadas por este como
+son los paquetes `ply` para la generación del lexer y el parser, y para la ejecución de los tests, `pytest`
+y `pytest-ordering`, todo esto se logra ejecutando el fichero `requirements.txt` de la forma: 
 
-## Sobre los Equipos de Desarrollo
+```bash
+pip install -r requirements.txt
+```
 
-Para desarrollar el compilador del lenguaje COOL se trabajará en equipos de 2 o 3 integrantes. 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. 
+Para ejecutar el compilador es necesario correr el archivo ```cool.sh``` ubicado en `/src/` dando como entrada la dirección del archivo a compilar de la siguiente forma:
 
-**⚠️ NOTA**: Debe completar el archivo `team.yml` con los datos correctos de cada miembro de su equipo.
+```bash
+cd src/
+./cool.sh '../tests/codegen/arith.cl'
+```
 
-## Sobre los Materiales a Entregar
+El archivo principal del compilador es `main.py`, módulo que contiene toda la lógica del compilador, si desea ejecutarlo debe pasar como argumento el `path` del fichero **.cl** con código fuente de COOL que se desea compilar, de la siguiente forma:
 
-Para la evaluación del proyecto Ud. debe entregar un informe en formato PDF (`report.pdf`) en esta carpeta, que resuma de manera organizada y comprensible la arquitectura e implementación de su compilador.
-El documento no tiene límite de extensión.
-En él explicará en más detalle su solución a los problemas que, durante la implementación de cada una de las fases del proceso de compilación, hayan requerido de Ud. especial atención.
+```bash
+python3 main.py '../tests/codegen/arith.cl'
+```
 
-## Estructura del reporte
+Un archivo en el mismo path del código fuente será creado, con el mismo nombre, pero con extensión **.mips** que puede ser ejecutado con **spim**.
 
-Usted es libre de estructurar su reporte escrito como más conveniente le parezca. A continuación le sugerimos algunas secciones que no deberían faltar, aunque puede mezclar, renombrar y organizarlas de la manera que mejor le parezca:
+Para ejecutar las pruebas localmente, debe tener instalado `Python 3.7`, `pip` y `make` que normalmente viene incluido en Linux, para hacerlo ejecute los siguientes comandos:
 
-- **Uso del compilador**: detalles sobre las opciones de líneas de comando, si tiene opciones adicionales (e.j., `--ast` genera un AST en JSON, etc.). Básicamente lo mismo que pondrá en este Readme.
-- **Arquitectura del compilador**: una explicación general de la arquitectura, en cuántos módulos se divide el proyecto, cuantas fases tiene, qué tipo de gramática se utiliza, y en general, como se organiza el proyecto. Una buena imagen siempre ayuda.
-- **Problemas técnicos**: detalles sobre cualquier problema teórico o técnico interesante que haya necesitado resolver de forma particular.
-
-## Sobre la Fecha de Entrega
-
-Se realizarán recogidas parciales del proyecto a lo largo del curso. En el Canal de Telegram se anunciará la fecha y requisitos de cada entrega.
+```bash
+cd src/
+make clean
+make test
+```
diff --git a/doc/Report.pdf b/doc/Report.pdf
diff --git a/doc/Report.pdf:Zone.Identifier b/doc/Report.pdf:Zone.Identifier
diff --git a/doc/cool-manual.pdf b/doc/cool-manual.pdf
diff --git a/doc/github-git-cheat-sheet.pdf b/doc/github-git-cheat-sheet.pdf
diff --git a/doc/team.yml b/doc/team.yml
@@ -1,10 +1,10 @@
 members:
-  - name: Nombre Apellido1 Apellido2
-    github: github_id
-    group: CXXX
-  - name: Nombre Apellido1 Apellido2
-    github: github_id
-    group: CXXX
-  - name: Nombre Apellido1 Apellido2
-    github: github_id
-    group: CXXX
+  - name: Laura Brito Guerrero
+    github: LauryGirl
+    group: C412
+  - name: Sheyla Cruz Castro
+    github: sheycc
+    group: C412
+  - name: Ariel Antonio Huerta Martín
+    github: huertaariel1
+    group: C412
diff --git a/img/img1.png b/img/img1.png
diff --git a/img/img10.png b/img/img10.png
diff --git a/img/img11.png b/img/img11.png
diff --git a/img/img12.png b/img/img12.png
diff --git a/img/img2.png b/img/img2.png
diff --git a/img/img3.png b/img/img3.png
diff --git a/img/img4.png b/img/img4.png
diff --git a/img/img5.png b/img/img5.png
diff --git a/img/img6.png b/img/img6.png
diff --git a/img/img7.png b/img/img7.png
diff --git a/img/img8.png b/img/img8.png
diff --git a/img/img9.png b/img/img9.png
diff --git a/requirements.txt b/requirements.txt
@@ -1,2 +1,3 @@
 pytest
 pytest-ordering
+ply
diff --git a/src/Readme.md b/src/Readme.md
diff --git a/src/code_generation/__init__.py b/src/code_generation/__init__.py
@@ -0,0 +1 @@
+from .code_generation import MyCodeGenerator