Skip to content

Latest commit

聽

History

History
146 lines (88 loc) 路 5.77 KB

README.es.md

File metadata and controls

146 lines (88 loc) 路 5.77 KB
Raw

Documentaci贸n Oficial de Raku

Build Status artistic

Run Status

Una versi贸n HTML de esta documentaci贸n puede ser encontrada en https://docs.perl6.org/. Esta 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 Raku Pod6, y GitHub asume que es Perl Pod).

README en otros lenguajes

Instalar p6doc

Este m贸dulo est谩 disponible en el ecosistema de m贸dulos de Raku. 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 rakubrew en modo shim, ejecuta tambi茅n:

$聽rakubrew rehash

para actualizar los correctores de compatibilidad de los ejecutables instalados.

Aparte de las dependencias de Raku, 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 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 en tu navegador.

Necesitar谩s, por lo menos, tener Mojolicious instalado. Adem谩s precisar谩s nodejs para activar el resaltado. Tambi茅n hay m贸dulos adicionales que podr铆as necesitar, inst谩lalos ejecutando:

$聽cpanm --installdeps .

隆Se precisa ayuda!

Raku 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 tiene una lista de issues actuales y partes de la documentaci贸n que faltan. El documento CONTRIBUTING 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?
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 Raku.

  2. El tratamiento que las implementaciones hacen de Pod6 es todav铆a un poco inconsistente; esto evita impactos potenciales en el tiempo de ejecuci贸n.

  3. Un repo separado en la cuenta de Raku 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?
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 Raku, ya sea del lenguaje o de sus tipos y rutinas. Quiero que sea 煤til para todo programador de Raku.

-- moritz

ENV VARS

  • Poner RAKU_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.
  • RAKU_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 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: