As mentioned in #1791210: Improve community docs the Readme could use a rewrite.

The patch in #1 is a first attempt.

I removed (among other things) the note about the "Recommended module", because there is no info available on why it is recommended. Hope you're okay with that.

In the tradition of "Pimped Readmes" I included a kick ass ascii project logo, but feel free to remove that

CommentFileSizeAuthor
#3 ds-improve-readme-1796638-3.patch2.48 KBbatigolix
#1 ds-improve-readme-1796638.patch2.48 KBbatigolix

Comments

batigolix’s picture

batigolix
Primary language Dutch
Location Utrecht
commented
StatusFileSize
new ds-improve-readme-1796638.patch2.48 KB

here the patch

swentel’s picture

swentel commented
Status: Needs review » Needs work

I'm not sure about the big logo on the top, I'll have to think about it :)

Little nitpick

+++ b/README.txtundefined
--- DRUSH --
+2. Go to Administration > Structure > Display Suite > Layout ¶

trailing space

batigolix’s picture

batigolix
Primary language Dutch
Location Utrecht
commented
Status: Needs work » Needs review
StatusFileSize
new ds-improve-readme-1796638-3.patch2.48 KB

Research has shown that a Big Bad Ass Ascii logo on top of a README files improves readability and increases acceptance of new versions of software, especially when the maintainer does not provide an upgrade path ;)

swentel’s picture

swentel commented
Status: Needs review » Fixed

Ok, committed to 7.x-2.x and 8.x-1.x branch :)

Status: Fixed » Closed (fixed)

Automatically closed -- issue fixed for 2 weeks with no activity.