+1 

Mezzanine's Readme is, at the time of writing, 795 lines long - pretty much 
an essay! The GH Readme for Django itself is short and sweet at just 44 
lines. That's a massive 94% reduction in lines. 

If you are looking for a python CMS to use, you want to read about 3 key 
features of Mezzanine that make it stand out from all the others, that's 
all. Then one could link to the Mezzanine website and documentation website 
for further details and even for installation steps etc.

Just my thoughts. Interesting to hear what the core devs think...

On Friday, 22 May 2015 10:43:37 UTC+1, Graham Oliver wrote:
>
> Hi all
> I would like to have a go at revamping the readme on GitHub
> https://github.com/stephenmcd/mezzanine/blob/master/README.rst
>
> Initial thoughts
> - Make it way shorter
> - Put the 'third party plugins' and 'sites using Mezzanine' lists in 
> separate documents
> - Add details of 'Core Development Team'
>
> Possibly also something for people (relatively) new to the Open Source 
> thing.....
>
> All feedback appreciated...
>
> This one I quite like (apart from the crypto stuff) 
> http://svn.apache.org/repos/asf/httpd/httpd/trunk/README
>
> Take Care
> g
>
>

-- 
You received this message because you are subscribed to the Google Groups 
"Mezzanine Users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
For more options, visit https://groups.google.com/d/optout.

Reply via email to