chibenwa opened a new pull request #654: URL: https://github.com/apache/james-project/pull/654
## Why GitHub is an important place to get traction and READMEs are the primary document people look at. They should be both informative AND easy to read. My personnal feeling is that James README is polluted by too much information, not readable and misses most of the points. The download page suffers similar flows. I would like to improve the current situation with this humble PR. ## How The goal is to keep the same level of information on the README but link external pages rather than polluting the README with content not pertinant for most readers. Also I propose using badges at the top for important links: download, license, website, CI, documentation, docker hub, websites posts. Hopefully these contents would get more visibility. I drastically simplified the index in the README that was clearly overcharged to me (takes more than my screen!) thus unreadable. Finally I also sanitised the download page as stated in https://www.mail-archive.com/[email protected]/msg71016.html ## Preview Preview these changes on my personnal repository: https://github.com/chibenwa/james-project/tree/improve-reame-14-09-2021 -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
