cookbook icon indicating copy to clipboard operation
cookbook copied to clipboard

Rework Readme and misc files

Open christianlupus opened this issue 3 years ago • 4 comments

christianlupus avatar May 14 '22 16:05 christianlupus

If reworking the main README.md I’d suggest to add a screenshot of the app there. I always like a repo having a visual representation of what it contains.

seyfeb avatar May 14 '22 21:05 seyfeb

Are there any further reworks needed for this issue? Is there anything I can do?

MarcelRobitaille avatar Jul 26 '22 03:07 MarcelRobitaille

Yes, there is more to be done. All files related to user-interaction (README.md, DEVELOPMENT.md, COPYING/LICENSE, translationfiles/README.md) should be read for correctness and redundant/outdated information should be corrected/redacted.

Further, I would vote for reworking/restructuring the README. For example the FAQ, I would move to the user documentation. I am just chipping in some links here:

christianlupus avatar Jul 26 '22 06:07 christianlupus

Are there any further reworks needed for this issue? Is there anything I can do?

User documentation should include some mention of markdown styles to be used in the app.

Benedikt81 avatar Sep 19 '22 06:09 Benedikt81