[Abcde-users] abcde installation / dependencies / requirements

[andrew]

On Wed, Sep 02, 2015 at 02:16:56PM +0200, Johannes Gernemann wrote:

> The abcde readme gives some overview of requirements for abcde. Some
> of them being mandatory, others alternative, others optional. I
> think the list isn't even complete. The normal user will be quite
> confused what to do.

You are speaking about the section in the README marked: REQUIREMENTS,
and I agree this could do with some work. Actually I have some mixed
feelings abuout the entire document which is for the most part a cut
down version of the changelog doc.

My old friend wikipedia gives some advice for a typical README:

    Configuration instructions
    Installation instructions
    Operating instructions
    A file manifest (list of files included)
    Copyright and licensing information
    Contact information for the distributor or programmer
    Known bugs[1]
    Troubleshooting[1]
    Credits and acknowledgments
    A changelog (usually for programmers)
    A news section (usually for users)

Many areas not covered by the existing abcde docs and the README in
particular, compunded by a quite detailed FAQ doc.

This might be a project to consider before the release of 2.7.1 :)

Andrew
-- 
You think that's air you're breathing now?