Message12590

Author jeff.allen
Recipients jamesmudd, jeff.allen, stefan.richthofer
Date 2019-07-19.20:31:18
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1563568278.3.0.478216945695.issue2764@roundup.psfhosted.org>
In-reply-to
Content
I think we need both README.txt and README.md. It is a pain to keep them in sync, but I don't think we need to.

README.md (on the master branch, anyway) changes as the project evolves, not in sync with a release. I always think "how to build this project" is the most valuable information. (On other branches it can do it for that branch or a label.)

README.txt contains what we want to say at installation time, to someone who may be using Jython for the first time. This would not include "how to build this project". It could include prominent acknowledgements or warnings. README.txt should probably confirm the version, although the installer does that anyway.

Fortunately, James had the perspicuity to make removing README.txt a separate change set, so I'll revert that and adjust the content.
History
Date User Action Args
2019-07-19 20:31:18jeff.allensetmessageid: <1563568278.3.0.478216945695.issue2764@roundup.psfhosted.org>
2019-07-19 20:31:18jeff.allensetrecipients: + jeff.allen, stefan.richthofer, jamesmudd
2019-07-19 20:31:18jeff.allenlinkissue2764 messages
2019-07-19 20:31:18jeff.allencreate