aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md66
1 files changed, 66 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..41b1a4e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,66 @@
+# Javañol RGG edition
+
+Javañol es un lenguaje de programación que, a pesar de llamarse como
+aquel lenguaje maldecido por sus usuarios, no se parece nada a él (al
+igual que ese otro lenguaje). Lo que sí es cierto, es que está en
+español, para que la comunidad hispanohablante le entienda.
+
+En su fase actual, es solo un prototipo no funcional; pero quizás
+algún día llegue a convertirse en un lenguaje real tampoco muy
+funcional. Eso depende del tiempo que sus autores dediquen en él; no
+les recomiendo poner su confianza en que suceda.
+
+Este proyecto se realizó para la materia de Lenguajes y Autómatas 2,
+con el profesor I.S.C. Ricardo González González. Somos estudiantes de
+Ingeniería en Sistemas Computacionales, en el [Tecnológico Nacional de
+México en Celaya](https://celaya.tecnm.mx/).
+
+Un agradecimiento especial a [Drew DeVault](https://drewdevault.com/),
+quien creó el lenguaje de programación [Hare](https://harelang.org),
+de cuyo [compilador](https://git.sr.ht/~sircmpwn/hare) tomamos un
+montón de código. Pero, hey, le añadimos algunas sorpresas.
+
+## Instalación
+
+Para que funcione esta cosa, se necesitan las siguientes librerías:
+
+| Librería | Autor | Licencia |
+|-------------------------------------------------------|------------------|-------------|
+| [python-gobject](https://pypi.org/project/PyGObject/) | James Henstridge | GNU LGPLv2+ |
+| [graphviz](https://pypi.org/project/graphviz/) | Sebastian Bank | MIT |
+
+Se requiere tener instalado [GTK4](https://gtk.org/), porque es lo que
+usamos para la interfaz gráfica, y te deseo suerte corriéndolo en
+Windows o macOS, la verdad no lo he probado, porque no uso ninguno de
+los dos. También se necesita [Graphviz](https://graphviz.org/), porque
+es con lo que se renderiza el árbol de sintaxis en PDF (¡sorpresa!)
+
+## Ejecución
+
+Para correr la interfaz gráfica, basta con posicionarte en el
+directorio raíz del proyecto, y ejecutar el siguiente script (solo
+para GNU/Linux):
+
+```bash
+./run_gui.sh
+```
+
+## Licencia
+
+```
+Copyright (C) 2022 Iván Alejandro Ávalos Díaz <avalos@disroot.org>,
+ Edgar Alexis López Martínez <edgarmlmp@gmail.com>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <https://www.gnu.org/licenses/>.
+```