os seguintes componentes e template são baseados na entrada de muitos que contribuíram para a discussão “criar um README.txt template”. Para o bem de ter um exemplo aperfeiçoado, estamos usando algum texto de amostra. A maior parte vem do README do módulo do menu de Administração.txt.

Índice

TOCs são opcionais,mas apreciados por longos ficheiros de leitura.,

introdução

a introdução (exigida) consistirá num ou dois parágrafos breves que resumem a finalidade e a função deste projecto. Esta introdução pode ser a mesma que o primeiro parágrafo da página do projecto.

a introdução deve incluir um link para a página do projeto e a fila de emissão. Se o projeto é uma caixa de areia, estes links devem ir para a caixa de areia até a promoção.

requisitos

a secção requisitos (exigidos) deve deixar claro se este projecto requer alguma coisa fora do núcleo Drupal para funcionar (módulos, bibliotecas, etc.)., Listar todos os requisitos aqui, incluindo aqueles que seguem indiretamente de outro módulo, etc. A idéia é informar os usuários sobre o que é necessário, para que tudo o que eles precisam possa ser adquirido e incluído antes de tentar instalar o módulo. Se não houver requisitos, escreva “sem requisitos especiais”.

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

módulos recomendados

Esta secção opcional lista módulos que não são necessários, mas que podem aumentar a utilidade ou experiência do utilizador do seu projecto. Certifique-se de descrever os benefícios de habilitar estes módulos.,

instalação

a secção de instalação (necessária*) deve deixar claro como instalar o módulo. No entanto, se os passos para instalar o módulo seguem as instruções padrão para Drupal 8, Drupal 7, Drupal 6/5, ou um tema, Não reinvente a roda — basta fornecer um link e explicar em detalhes quaisquer passos que possam divergir destes passos. Tome nota das integrações Drush. Em um caso onde muitos comandos Drush são adicionados, considere adicionar uma seção para Drush.

considere a substituição desta seção por uma instalação autônoma.,ficheiro txt se as suas instruções de instalação forem especialmente complexas.

* – necessário a menos que uma instalação separada.txt é fornecido.

Drupal 7

Drupal 8

configuração

a secção de configuração (necessária) é necessária mesmo quando é necessária pouca configuração. Use esta secção para listar notas especiais sobre a configuração deste módulo – incluindo, mas não limitado, as permissões. Esta secção é particularmente importante se o módulo necessitar de configuração adicional fora da UI Drupal.,

Se o módulo tiver pouca ou nenhuma configuração, deverá usar este espaço para explicar como a activação/desactivação do módulo irá afectar o site.

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.

ou

solução de problemas FAQ

estas secções são opcionais. Se estiverem presentes, devem abordar as questões que são colocadas frequentemente na fila de questões (isto irá poupar-lhe tempo no futuro). Esboçar problemas comuns que as pessoas encontram junto com soluções (links são ok se os passos são longos, mas é frequentemente útil fornecer um resumo já que links às vezes ficam obsoletos).,

mantenedores

Esta secção é opcional e deve substituir quaisquer mantenedores autónomos pré-existentes.ficheiro txt.a ajuda avançada

a ajuda avançada

a ajuda avançada irá mostrar o ficheiro README no ecrã se estiver activa.

tudo sobre Markdown

durante a vida útil do projeto Drupal, nunca houve um consenso claro sobre como um arquivo README deve ser, e muitos estilos diferentes existem como resultado (ver links abaixo). No entanto, nós preferimos novos projetos para usar o formato descrito nesta página, ou um formato reconhecido pelo Módulo de filtro Markdown., Se você usar o Markdown, seu arquivo deve ser nomeado README.md (e usar a sintaxe de marcação válida), caso contrário deve ser chamado README.txt.

dicas de formatação rápida

Aqui está um resumo do formato preferido para o README.txt:

• posições em todas as maiúsculas.
• posições sublinhadas com ===/--- até ao comprimento da posição, seguido de uma linha em branco.duas linhas anteriores às posições (excepto a primeira).balas denotadas por asteriscos ( * ) com travessões Pendurados.
• listas numeradas indentavam 4 espaços.,listas com pontos indentaram 1 espaço.
• Text manually word-wrapped within around 80 cols.

readme de amostra

alguns README de amostra:

• Morbus’ README.o estilo txt (que corresponde ao estilo do núcleo Drupal o mais próximo).migalhas de pão simples README.md (que usa este modelo)