Ver Feed RSS

acris

Criando um readme - dúvida cruel

Avalie este Post de Blog
Já fiz muitas revisões de tutoriais, notas de lançamento e até readmes, mas pela primeira vez fui obrigada a escrever um readme do zero, para um programa que acabei de lançar em fase beta, o Linha do Texto. De repente percebi que, embora já tivesse lido muitos readmes, não sabia como fazer um. O google não ajudou muito e então comecei a escrever o que achei que seria importante:
  • introdução falando sobre o que é o programa (é um jogo educativo e científico) e como jogar
  • instruções sobre como criar um novo jogo
  • um TODO, com lista de bugs e de coisas a melhorar, que fui descobrindo ao usar o programa para criar o próprio readme
Não fiquei satisfeita e fui procurar na Wikipedia. Para minha surpresa, não havia a entrada "readme" na Wikipédia em português, somente em inglês, então decidi traduzir o texto do inglês e agora todos podem ler, em português, o que é e o que pode ter dentro de um Readme.
É interessante que, ao contrário do que eu pensava, seu conteúdo não é fixo, mas seria de bom tom colocar dentro do meu informações sobre copyright, por exemplo.
O Readme é um arquivo importante para o software livre, especialmente porque os Helps nascem dele. Fiquei impressionada que esta informação não esteja presente em português: ou todo mundo que faz readmes no Brasil o faz em inglês (como eu mesma o fiz, veja no sourceforge) ou não se dá muita importância a isso.
Categorias
Não Categorizado

Comentários


+ Enviar Comentário




Visite: BR-Linux ·  VivaOLinux ·  Dicas-L