Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
commit accidentaly deletes README.es.md
- Loading branch information
1 parent
e7ab3cd
commit f88f039
Showing
1 changed file
with
150 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,150 @@ | ||
| # Documentaci贸n Oficial de Perl 6 | ||
|
|
||
| [](https://travis-ci.org/perl6/doc) [](https://opensource.org/licenses/Artistic-2.0) | ||
|
|
||
| [](https://app.shippable.com/github/perl6/doc) | ||
|
|
||
| Una versi贸n HTML de esta documentaci贸n puede ser encontrada en [https://docs.perl6.org/](https://docs.perl6.org/). | ||
| 脡sta es la documentaci贸n recomendada. | ||
|
|
||
| Tambi茅n hay disponible un comando para la terminal: "p6doc". | ||
|
|
||
| (Si est谩s buscando el repositorio en GitHub, la mayor铆a de los archivos no ser谩n mostrados correctamente, | ||
| ya que esto es Perl 6 Pod, y GitHub asume que es Perl 5 Pod). | ||
|
|
||
| ## README en otros lenguajes | ||
|
|
||
| * [README en alem谩n](README.de.md) | ||
| * [README en chino](README.zh.md) | ||
| * [README en italiano](README.it.md) | ||
| * [README en ingl茅s](README.md) | ||
| * [README en franc茅s](README.fr.md) | ||
|
|
||
| ## Instalar p6doc | ||
|
|
||
| Este m贸dulo est谩 disponible en el ecosistema de m贸dulos de Perl 6. Usa: | ||
|
|
||
| $ zef install p6doc | ||
|
|
||
| para instalar los binarios y a帽adirlo a tu path. | ||
|
|
||
| ## Usar p6doc | ||
|
|
||
| Cuando tengas `perl6` (Rakudo) a帽adido al `PATH`, ejecuta | ||
|
|
||
| $ ./bin/p6doc Str | ||
|
|
||
| para ver la documentaci贸n para la clase `Str`, o | ||
|
|
||
| $ ./bin/p6doc Str.split | ||
|
|
||
| para ver la documentaci贸n del m茅todo `split` de la clase `Str`. Puedes | ||
| omitir `./bin` si lo has instalado mediante `zef`. | ||
| Tambi茅n puedes hacer | ||
|
|
||
| $ p6doc -f slurp | ||
|
|
||
| para buscar la documentaci贸n est谩ndar de funciones. Dependiendo de la velocidad | ||
| de tu disco duro y de la versi贸n de Rakudo, es posible que tarde unos minutos. | ||
|
|
||
| ------- | ||
|
|
||
| ## Generando la documentaci贸n en HTML | ||
|
|
||
| Instala las dependencias ejecutando lo siguiente en el directorio correspondiente: | ||
|
|
||
| $ zef --deps-only install . | ||
|
|
||
| Si usas [`rakudobrew`](https://github.com/tadzik/rakudobrew), ejecuta tambi茅n: | ||
|
|
||
| $ rakudobrew rehash | ||
|
|
||
| para actualizar los correctores de compatibilidad de los ejecutables instalados. | ||
|
|
||
| Aparte de las dependencias de Perl 6, necesitas tener `graphviz` instalado. En Debian | ||
| lo puedes instalar mediante: | ||
|
|
||
| $ sudo apt-get install graphviz | ||
|
|
||
| Para generar las p谩ginas webs de la documentaci贸n, simplemente ejecuta: | ||
|
|
||
| $ make html | ||
|
|
||
| Ten en cuenta que debes tener instalado [nodejs](https://nodejs.org) | ||
| para producir el contenido HTML con el anterior comando, en particular, | ||
| `node` deber铆a estar en tu `PATH`. | ||
|
|
||
| Cuando las p谩ginas hayan sido generadas, puedes verlas localmente | ||
| en tu ordenador ejecutando el programa `app.pl`: | ||
|
|
||
| $ make run | ||
|
|
||
| Una vez hecho lo anterior, puedes ver la documentaci贸n de ejemplo | ||
| dirigi茅ndote a [http://localhost:3000](http://localhost:3000) en tu navegador. | ||
|
|
||
| Necesitar谩s, por lo menos, tener [Mojolicious](https://metacpan.org/pod/Mojolicious) | ||
| instalado. Adem谩s precisar谩s [nodejs](https://nodejs.org) para activar el resaltado. | ||
| Tambi茅n hay m贸dulos adicionales que podr铆as necesitar, inst谩lalos ejecutando: | ||
|
|
||
| $ cpanm --installdeps . | ||
|
|
||
| --------- | ||
|
|
||
| ## 隆Se precisa ayuda! | ||
|
|
||
| Perl 6 no es un lenguaje de programaci贸n peque帽o, y documentarlo requiere mucho esfuerzo. Cualquier ayuda es bienvenida. | ||
|
|
||
| Algunas maneras en las que puedes ayudarnos: | ||
|
|
||
| * A帽adiendo documentaci贸n de clases, roles, m茅todos u operadores. | ||
| * A帽adiendo ejemplos de uso a la documentaci贸n existente. | ||
| * Revisando y corrigiendo la documentaci贸n. | ||
| * Abriendo issues en GitHub si consideras que falta documentaci贸n. | ||
| * Haciendo `git grep TODO` en este repositorio, y reemplazando los items TODO con documentaci贸n. | ||
|
|
||
| [Esta p谩gina](https://github.com/perl6/doc/issues) tiene una lista de issues actuales y partes de la documentaci贸n que faltan. El documento [CONTRIBUTING](CONTRIBUTING.md) explica brevemente c贸mo empezar a contribuir. | ||
|
|
||
| -------- | ||
| ## Algunas aclaraciones: | ||
|
|
||
| **P:** 驴Por qu茅 no est谩is incluyendo la documentaci贸n en el c贸digo fuente del CORE?<br> | ||
| **R:** Debido a varias razones: | ||
|
|
||
| 1. Esta documentaci贸n pretende ser universal con respecto a una versi贸n dada de una especificaci贸n, y no necesariamente estar atada a una implementaci贸n espec铆fica de Perl 6. | ||
|
|
||
| 2. El tratamiento que las implementaciones hacen de Pod 6 es todav铆a un poco inconsistente; esto evita impactos potenciales en el tiempo de ejecuci贸n. | ||
|
|
||
| 3. Un repo separado en la cuenta de Perl 6 de GitHub invita a m谩s contribuidores y editores a participar. | ||
|
|
||
| **P:** 驴Deber铆a incluir los m茅todos de las superclases o de los roles?<br> | ||
| **A:** No. La versi贸n en HTML ya los incluye, y el script `p6doc` tambi茅n. | ||
|
|
||
| -------- | ||
|
|
||
| ## Objetivo | ||
|
|
||
| > Quiero que p6doc y docs.perl6.org lleguen a ser el recurso n煤mero 1 para consultar cualquier | ||
| > caracter铆stica de Perl 6, ya sea del lenguaje o de sus tipos y rutinas. Quiero que sea 煤til para todo programador de Perl 6. | ||
| > | ||
| > -- moritz | ||
| -------- | ||
|
|
||
| # ENV VARS | ||
|
|
||
| - Poner `P6_DOC_TEST_VERBOSE` a `true` para mostrar mensajes durante la ejecuci贸n del conjunto de tests. Pr谩ctico para depurar un test suite que falla. | ||
| - `P6_DOC_TEST_FUDGE` cambia los ejemplos de c贸digo `skip-test` a TODO en el test `xt/examples-compilation.t`. | ||
|
|
||
| # LICENCIA | ||
|
|
||
| El c贸digo en este repositorio est谩 disponible bajo la Artistic License 2.0 como lo public贸 la Perl Foundation. Ver el fichero [LICENSE](LICENSE) para ver el texto completo. | ||
|
|
||
| Este repositorio tambi茅n contiene c贸digo de terceros que podr铆a tener otra licencia, en cuyo caso indican al principio de los mismos el copyright y sus t茅rminos de licencia. Actualmente incluyen: | ||
|
|
||
| * librer铆as jQuery y jQuery UI: Copyright 2015 jQuery Foundation y otros contribuidores; [Licencia MIT](http://creativecommons.org/licenses/MIT) | ||
| * [plugin jQuery Cookie](https://github.com/js-cookie/js-cookie): | ||
| Copyright 2006, 2015 Klaus Hartl & Fagner Brack; | ||
| [MIT License](http://creativecommons.org/licenses/MIT) | ||
| * Ejemplos de StackOverflow [Licencia MIT](http://creativecommons.org/licenses/MIT); ([ref #1](http://stackoverflow.com/a/43669837/215487) for [1f7cc4e](https://github.com/perl6/doc/commit/1f7cc4efa0da38b5a9bf544c9b13cc335f87f7f6)) | ||
| * Table sorter plugin from https://github.com/christianbach/tablesorter ; | ||
| [Licencia MIT](http://creativecommons.org/licenses/MIT) |