From 6a81e51dee8c2f9a649dcb8f6e18df61ea2b46f6 Mon Sep 17 00:00:00 2001 From: Danilo Pedraza Date: Tue, 13 Feb 2024 12:48:30 -0500 Subject: [PATCH] add Makefile instructions to README --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 878aa8b..53c9de0 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,17 @@ # lang Aquí vamos a registrar nuestro proyecto de crear un lenguaje de programación. Esto incluye el diseño de lenguaje y la implementación de un compilador. + +## Uso + +Tenemos un `Makefile` con varios comandos: + +- `make build-docker` construye la imagen Docker para el sistema, +- `make run-docker` ejecuta la imagen, +- `make run-tests` ejecuta las pruebas unitarias. + +Los siguientes comandos se deberían ejecutar en la terminal del contenedor, tras haber hecho `make run-docker`: + +- `make install-dependencies` instala las dependencias de Go, +- `make run-tests-ci` ejecuta las pruebas que se van a hacer en la CI de GitHub, +- `make generate-parsing-files` genera el código de ANTLR para el sistema. Se debería ejecutar si la gramática del lenguaje fue modificada o los archivos no existen. El código generado por ANTLR no es rastreado en este repositorio.