[pyar] Writing a README

[Angel Java Lopez]

Otra cosa que agregaria:

- En que lenguaje esta escrito
- Para que version esta preparado (p.ej. si es Python, que diga
explicitamente que versiones de Python soporta)
- En que plataformas corre
- Como ejecutar los tests
- Como instalar las dependencias
- Los casos de uso a los que esta dirigido
- etc... etc...

Hay varios proyectos que ASUMEN que todos sabemos esas cosas, pero snif...
no es el caso ;-)

No se, tal vez no se habitua lo de arriba, pero a mi me parece que reduce
friccion.

Me encontre con descripciones tipo:

"Herramienta que tira pirulines"

pero que en realidad era:

"Herramienta que tira pirulines en Django, no para Ruby o Node.js, en
Django, entiendan, y solo para tirar pirulines cuando se deploya en Heroku,
no pidan otra cosa, ah, y no se maten, solo corre con Python 2.7"

No se, digo ;-)

Nos leemos!

Angel "Java" Lopez
@ajlopez


On Mon, May 5, 2014 at 8:27 PM, Pedro Jose Pezzarini <jose2190 en gmail.com>wrote:

> absolutely  great for this lines:
> - Install the shit.
> - Run it.
> - Look for error messages.
>
>
> 2014-05-05 20:10 GMT-03:00 Apokalyptica Painkiller <
> apokalyptica79 en gmail.com>:
>
>> Good documentation is important. I just heard two colleagues talking and
>> what one of them said sounded like a README.
>>
>> Writing a readme<http://reinout.vanrees.org/weblog/2014/05/05/writing-a-readme.html>
>>
>> --
>> I live each day
>> Like it's my last
>> I live for rock and roll
>> I never look back
>>
>> I'm a rocker
>> Do as I feel as I say
>> I'm a rocker
>> And no one can take that away
>>
>>
>> _______________________________________________
>> pyar mailing list pyar en python.org.ar
>> http://listas.python.org.ar/listinfo/pyar
>>
>> PyAr - Python Argentina - Sitio web: http://www.python.org.ar/
>>
>> La lista de PyAr esta Hosteada en USLA - Usuarios de Software Libre de
>> Argentina - http://www.usla.org.ar
>>
>
>
> _______________________________________________
> pyar mailing list pyar en python.org.ar
> http://listas.python.org.ar/listinfo/pyar
>
> PyAr - Python Argentina - Sitio web: http://www.python.org.ar/
>
> La lista de PyAr esta Hosteada en USLA - Usuarios de Software Libre de
> Argentina - http://www.usla.org.ar
>
------------ próxima parte ------------
Se ha borrado un adjunto en formato HTML...
URL: <http://listas.python.org.ar/pipermail/pyar/attachments/20140505/acce6d3f/attachment-0001.html>