Write new readme, taking docs.codice.eu into account. Don't bother with technical details, don't duplicate documentation. Focus on script's purpose, introduce some screens, general idea and futures.
Remaining question: should the readme describe basic installation process anyway? IMO link to a proper chapter in documentation would be enough, but won't that one more click scare away some potential users? I'm strongly against duplicating informations, but maybe shortest and most common path to get up&running should be described there?
Sobak
commented
8 years ago
Write new readme, taking docs.codice.eu into account. Don't bother with technical details, don't duplicate documentation. Focus on script's purpose, introduce some screens, general idea and futures.
Remaining question: should the readme describe basic installation process anyway? IMO link to a proper chapter in documentation would be enough, but won't that one more click scare away some potential users? I'm strongly against duplicating informations, but maybe shortest and most common path to get up&running should be described there?