Browse code

Adición de documentación

NikaZhenya authored on 08/04/2018 17:37:15
Showing 1 changed files
... ...
@@ -0,0 +1,34 @@
1
+# AML *script* general
2
+
3
+Genera formatos APK, EPUB, JSON, MOBI, PDF y WEB del *Diccionario escolar* y del *Diccionario de mexicanismos* de la Academia Mexicana de la Lengua.
4
+
5
+> Nota: requiere los repositorios [`aml-escolar`](https://github.com/NikaZhenya/aml-escolar) o [`aml-mexicanismos`](https://github.com/NikaZhenya/aml-mexicanismos) como directorios hermanos a este repositorio.
6
+
7
+Uso:
8
+
9
+```
10
+ruby crear.rb
11
+```
12
+
13
+Parámetros opcionales:
14
+
15
+* `proyecto`: Nombre del proyecto en específico para no generar todos (p. ej. `aml-escolar` o `aml-mexicanismos`).
16
+* `--no-version-increase`: Evita incrementar el número de versión del APK.
17
+* `--push`: Hace push a los repositorios de cada obra.
18
+* `-h` || `--help`: Muestra esta ayuda.
19
+
20
+## Dependencias
21
+
22
+Este script requiere las siguientes dependencias:
23
+
24
+* [`ruby`](https://www.ruby-lang.org/)
25
+* [`roo`](https://github.com/roo-rb/roo)
26
+* [`pecas`](https://github.com/NikaZhenya/pecas)
27
+* [`pandoc`](https://pandoc.org/)
28
+* [`kindlegen`](https://www.amazon.com/gp/feature.html?ie=UTF8&docId=1000765211)
29
+* [`pdflatex`](https://www.latex-project.org/)
30
+* [`cordova`](https://cordova.apache.org/)
31
+
32
+## Licencia
33
+
34
+Software bajo [licencia GPLv3+](https://gnu.org/licenses/gpl.html).