jd api
1.0.0
Este ReadMe normalmente documentava quaisquer etapas necessárias para colocar o aplicativo em funcionamento.
Coisas que você pode querer cobrir:
Versão Ruby
Dependências do sistema
Configuração
Criação do banco de dados
Inicialização do banco de dados
Como executar a suíte de teste
Serviços (filas de emprego, servidores de cache, mecanismos de pesquisa, etc.)
Instruções de implantação
...
Sinta -se à vontade para usar um idioma de marcação diferente se você não planeja executar rake doc:app
.