Your README is really detailed! You could break out the api portion into session_cache.api.php. Some of it could go into an INSTALL.txt?

Comments

rdeboer’s picture

Assigned: Unassigned » rdeboer

Hi Karl,

Thank you for your comments.

Agree with providing a session_cache_api.php and moving appropriate content from README.txt into it. Have done this.

Not so sure about INSTALL.txt. With this module there wouldn't be a lot in the INSTALL.txt as it's just a matter of enabling the module and selecting the storage mechanism on the config page. I have made that more explicit with a new section right at the top of the README.

In general, taking install instructions out of the README.txt may disrupt the flow of the text and therefore make it harder rather than easier for the user to understand.
A quick scan on my Drupal7 test site reveals that many contrib maintainers feel the same: only 3 out of the 53 contrib modules on my system have an INSTALL.txt (Date, Location, and search_api_solr).

Rik

kscheirer’s picture

Status: Active » Fixed

Good enough for me, thanks Rik!

Status: Fixed » Closed (fixed)

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