15 ms·
UPDATE: The README.md has now been updated with a link to the older version that describes what the project is about. Thanks to the maintainer for doing this. T
by _kst_ 6y ago
UPDATE: The README.md has now been updated with a link to the older version that describes what the project is about. Thanks to the maintainer for doing this. The remainder of this comment is obsolete (except for the last paragraph).
As others have mentioned, the current site (README.md) says very little about what Flynn is.
You can see a version of the repo and README.md, just before it became unmaintained, here:
https://github.com/flynn/flynn/tree/2c20757de8b32a40ba06f7e5b363b2d4dd6b332e https://github.com/flynn/flynn/tree/2c20757de8b32a40ba06f7e5...
IMHO it would have been much better if the maintainers had added the "Flynn is Unmaintained" information to the top of the README.md rather than removing all the existing information. I've submitted a GitHub issue suggesting it: https://github.com/flynn/flynn/issues/4623 https://github.com/flynn/flynn/issues/4623
A plea to project maintainers in general: Please include enough information in your top-level README (or README.md, or README.whatever) so that someone who has never heard of your project can find get a good overview. I've also seen READMEs that only discuss the most recent changes. That's fine for readers who have already been following the project, but not for a more general audience.