los siguientes componentes y plantilla se basan en la entrada de muchos de los que contribuyeron a la discusión » crear un README.txt template». Por el bien de tener un ejemplo detallado, estamos usando un texto de muestra. La mayor parte proviene del módulo README del menú de administración.txt.

tabla de contenidos

Los TDC son opcionales pero apreciados para archivos README largos.,

Introducción

la introducción (obligatorio) consistirá en un breve párrafo o dos que resumen el propósito y la función de este proyecto. Esta introducción puede ser la misma que el primer párrafo de la página del proyecto.

la introducción debe incluir un enlace a la página del proyecto y a la cola de problemas. Si el proyecto es un sandbox, estos enlaces deben ir al sandbox hasta la promoción.

Requirements

la sección de requisitos (requerido) dejará claro si este proyecto requiere algo fuera del núcleo de Drupal para funcionar (módulos, bibliotecas, etc.)., Enumere todos los requisitos aquí, incluidos los que siguen indirectamente de otro módulo, etc. La idea es informar a los usuarios sobre lo que se requiere, para que todo lo que necesitan pueda ser adquirido e incluido antes de intentar instalar el módulo. Si no hay requisitos, escriba «sin requisitos especiales».

REQUIREMENTS------------This module requires no modules outside of Drupal core.

módulos recomendados

esta sección opcional enumera los módulos que no son necesarios, pero que pueden mejorar la utilidad o la experiencia del usuario de su proyecto. Asegúrese de describir los beneficios de habilitar estos módulos.,

instalación

la sección de instalación (obligatorio*) aclarará cómo instalar el módulo. Sin embargo, si los pasos para instalar el módulo siguen las instrucciones estándar para Drupal 8, Drupal 7, Drupal 6/5 o un tema, no reinvente la rueda — Simplemente proporcione un enlace y explique en detalle cualquier paso que pueda divergir de estos pasos. Tome nota especial de las integraciones de Drush. En caso de que se agreguen muchos comandos Drush, considere agregar una sección para Drush.

considere reemplazar esta sección con una instalación independiente.,archivo txt si sus instrucciones de instalación son especialmente complejas.

* – obligatorio a menos que se instale por separado.se proporciona txt.

Drupal 7

Drupal 8

Configuration

la sección de configuración (requerido) es necesaria incluso cuando se requiere poca configuración. Utilice esta sección para enumerar notas especiales sobre la configuración de este módulo, incluidos, entre otros, los permisos. Esta sección es particularmente importante si el módulo requiere configuración adicional fuera de la interfaz de usuario de Drupal.,

si el módulo tiene poca o ninguna configuración, debe usar este espacio para explicar cómo habilitar / deshabilitar el módulo afectará al sitio.

CONFIGURATION------------- * Configure the user permissions in Administration " People " Permissions: - Use the administration pages and help (System module) The top-level administration categories require this permission to be accessible. The administration menu will be empty unless this permission is granted. - Access administration menu Users with this permission will see the administration menu at the top of each page. - Display Drupal links Users with this permission will receive links to drupal.org issue queues for all enabled contributed modules. The issue queue links appear under the administration menu icon. * Customize the menu settings in Administration " Configuration and modules " Administration " Administration menu. * To prevent administrative menu items from appearing twice, you may hide the "Management" menu block.

o

Solución de problemas & preguntas frecuentes

Estas secciones son opcionales. Si están presentes, deben responder a las preguntas que se hacen con frecuencia en la cola de problemas (esto le ahorrará tiempo en el futuro). Describa los problemas comunes que las personas encuentran junto con las soluciones (los enlaces están bien si los pasos son largos, pero a menudo es útil proporcionar un resumen ya que los enlaces a veces se vuelven obsoletos).,

mantenedores

Esta sección es opcional y debe reemplazar a cualquier mantenedor independiente preexistente.archivo txt.

ayuda avanzada

ayuda avanzada mostrará el archivo README en la pantalla si está habilitado.

todo sobre Markdown

durante la vida del proyecto Drupal, nunca ha habido un consenso claro sobre cómo debería ser un archivo README, y como resultado existen muchos estilos diferentes (ver enlaces a continuación). Sin embargo, preferimos que los nuevos proyectos utilicen el formato descrito en esta página, o un formato reconocido por el módulo de filtro Markdown., Si utiliza Markdown, su archivo debe tener un nombre README.md (y use una sintaxis de Markdown válida), de lo contrario debería llamarse README.txt.

consejos de formato rápido

Aquí hay un resumen del formato preferido para README.txt:

• encabezados en mayúsculas.
• Encabezamientos subrayados con ===/--- a la longitud del título, seguido por una línea en blanco.
• Dos líneas antes de los encabezados (excepto la primera).
• viñetas marcadas con asteriscos ( * ) con sangrías colgantes.
• listas numeradas con sangría de 4 espacios.,
• listas con viñetas con sangría 1 espacio.
• Texto envuelto manualmente en palabras dentro de unos 80 cols.

Readme de muestra

algunos archivos README de muestra:

• README de Morbus.estilo txt(que coincide con el estilo de Drupal core Más cercano).
• migas de pan fáciles README.md (que utiliza esta plantilla)