README y Wiki

[Osukaru]

Hay que modificar el README.md para que explique los pasos que hay que seguir para clonar y hacer funcionar el proyecto en un entorno de desarrollo. También hay que colgar en el Wiki los TXT que hay en la carpeta src/SFM/WebsiteBundle/Resources/doc en formato REstructuredText o MarkDown.

[desarrolla2]

Hola Oscar.

Yo subi un fichero how_colaborate.rst que contiene los pasos para clonar el proyecto desde 0, hasta hacer el pull request.

Intenté usar REstructuredText, pero no se si con mucho éxito.

Un saludo!

[mgallego]

Creo que lo suyo son dos ficheros. El primero README que explica en que consiste la app y otro INSTALL que dice como instalarla.
Asignamelo si quieres que quiero aprender MD

[mgallego]

Si a nadie le parece mal lo voy a hacer como este de FOS https://github.com/FriendsOfSymfony/FOSUserBundle/blob/master/README.markdown que me parece mas claro que por ejemplo este otro también de FOS https://github.com/FriendsOfSymfony/FOSRestBundle/blob/master/README.md donde dan demasiada información en el mismo fichero.

Como nuestro cometido es aprender con este desarrollo, mientras mas estructurado esté pienso que será mejor.

[desarrolla2]

Ocupate de reestructurar la documentación, y puedes ir preparando una charla "best practices en manejo de documentación (con sphinx)"

Saludos!

[mgallego]

@desarrolla2 de sphinx no se nada, pero bueno, puedo aprovechar ya que estoy con la documentación le echare un ojo a ver que tal, creo que @Osukaru ya ha tocado algo, lo comentaré con él.

[Osukaru]

@mgallego, yo trasteé un poco generando la doc de Symfony, echale un vistazo a mi blog. También aprendí a generar doc automática en varios formatos con el libro progit, que se puede generar en html, pdf y mobi, pero no se hacia con sphinx ni estaban los fuentes en rst, no me acuerdo que formato usaban. Se pueden mirar las distintas formas que haya y elegir la que mas convenga. Lo interesante es aprender a exportarla automáticamente en varios formatos.
------Mensaje original------
De: mgallego
Para: Oscar Lopez
Asunto: Re: [symfony-madrid] README y Wiki (#5)
Enviado: 3 de sep de 2011 13:28

@desarrolla2 de sphinx no se nada, pero bueno, puedo aprovechar ya que estoy con la documentación le echare un ojo a ver que tal, creo que @Osukaru ya ha tocado algo, lo comentaré con él.

Reply to this email directly or view it on GitHub:
symfony-madrid/symfony-madrid#5 (comment)

Enviado desde mi BlackBerry® de Vodafone

[desarrolla2]

Es sencillo, si tienes alguna duda, enviala a la lista.