The current readme.txt is very out-of-date. It talks about Drupal 4 and 5, with no mention of 6 or 7, let alone 8. We need to decide what the best practice is, regarding keeping history in the file or deleting all the old stuff and only keeping things relevant to 8.x
A link to this file is given at /admin/help/scheduler. When clicked we just get the plain text displayed in the browser. I wonder if we can do this a better way and display a nicer-to-read page, such as I have seen on other sites, where they have a readme.md (or something like that)
Comments
Comment #2
sandipshirsale commentedComment #3
sandipshirsale commentedCreated a patch file to update readme.txt file for 8.x
Comment #4
jonathan1055 commentedThanks @sandipshirsale for starting this.
I have reviewed the patch, and your new readme is mostly just a copy of the project front page. Whilst this is an improvement on the current readme, I think we need to give more information than just that. Plus many things do not need to copied. I will make some changes and post an updated patch.
Jonathan
Comment #5
jonathan1055 commentedHere's an update, based on the template at https://www.drupal.org/node/2181737
Comment #8
jonathan1055 commentedFixed line spacing and indentation to allign to recommended layouts. Added note about hooks and events. Added previous maintainers.