diff --git a/README.md b/README.md new file mode 100644 index 0000000..4b80fa5 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# Generador de cancioneros web + +Este programa crea una página web en base a un cancionero en LaTeX, como por ejemplo el [cancionero del 25 aniversario][0]. +Para crearlo, basta con ejecutar `make`. + +El resultado puede verse en https://canciones.sanleandro-obispo.net + +Dependencias: `python3` y `make`. + +## Características + +* **Genera páginas estáticas**, y que por tanto se sirven rápidamente. +* **Enlaza las canciones con sus audios correspondientes**. Para esto, en la carpeta `audios/` se deben colocar. El nombre de cada fichero debe seguir el formato `NNN_YYYY-MM-DD.mp3`, donde `NNN` es el índice numérico de la canción (tres dígitos, rellenar con ceros) y el resto es la fecha de la grabación. +* **Vista adecuada para móvil** (con controles de zoom). +* **Transposición de acordes**. + +[0]: https://gitlab.com/parroquia-san-leandro/cancionero25 \ No newline at end of file