inqlude icon indicating copy to clipboard operation
inqlude copied to clipboard

Brittle handling of KDE Framework's readme

Open vHanda opened this issue 10 years ago • 1 comments

Inqlude expects every framework to have its name as the largest header, and to have an Introduction section. Not all frameworks wish to follow this scheme.

It doesn't make sense to get the name of the framework from the README.md file. Get it from the name of the repository. Also, there is a short description in the metainfo.yml file, that can be used in place of the "Introduction" header.

vHanda avatar Sep 22 '15 01:09 vHanda

We use the short description from the metainfo.yml as one-line summary already. That's what it's meant to be. The introduction is the longer multi-line or multi-paragraph description formatted with markdown. This is nowhere else than in the README, so we can't get rid of that at the moment.

We already use the name of the repository as the name of the framework. The content of the header of the README is used as display name, which includes proper capitalization and spaces. This information is also nowhere else.

That said, I would not have a problem with moving more information to the metainfo.yml. If somebody does that I will happily adapt Inqlude to take the info from there. We just have to make sure that we don't change READMEs in a way not understandable by Inqlude before the info is accessible from somewhere else and Inqlude is adapted.

cornelius avatar Sep 29 '15 19:09 cornelius