Stephen Niedzielski sniedzielski@wikimedia.org wrote:
The Android team uses README.mediawiki but it's just a link[0] to a wiki. It seemed appropriate to use a wiki for an app called "Wikipedia".
[0] https://www.mediawiki.org/wiki/Wikimedia_Apps/Team/Wikipedia_Android_app_hac...
[...]
That destroys the self-containedness of source code. README, INSTALL & Co. should have information and instruc- tions referring to the specific version of a software, ei- ther in a distribution tarball or in a particular branch, and they should be updated in sync with changes to the source that affect them so that a user can successfully use it.
There may be additional information elsewhere, like coding conventions patches by the user must meet to be accepted or general design considerations, but a user should not have to guess how to get a software running.
Tim