Frameworks/Epics/KF5.0 Release Preparation/Necessary Files

From KDE Community Wiki

README.md

Create or update README.md files for all frameworks (ordinary Markdown, not GitHub's extension, although if you have to you can get away with Doxygen's extensions). Ensure they contain at least the following: 

# @FrameworkName@

@One-line summary@

## Introduction

@Description of the framework@

## Links

- Home page: <https//projects.kde.org/projects/frameworks/@framework_name@
- Mailing list: <https://mail.kde.org/mailman/listinfo/kde-frameworks-devel>
- IRC channel: #kde-devel on Freenode
- Git repository: <https://projects.kde.org/projects/frameworks/@framework_name@/repository>

Aim to tell people who know nothing about the framework what it aims to do (and why they should use it) in the Introduction section. Add other sections if there is other important information they should know (including examples if you think that would be helpful). You might want to highlight the most important classes, utilities or CMake macros. Try not to make it too long though (if the file is much over 50 lines, consider whether some of the information belongs somewhere else).

If you can get someone not particularly familiar with the framework to help write the README.md file, even better - they are more likely to spot what information is useful.

Try to keep the width within 80 characters for most of the file (although long links, like the repository one at the end, may break that).

See karchive for an example README.md file that I (Alex Merry) consider a good example.

Status Framework Contact
DONE frameworkintegration Aurélien Gâteau
DONE karchive Aurélien Gâteau
DONE kauth Aurélien Gâteau
DONE kbookmarks Aurélien Gâteau
DONE kcmutils Aurélien Gâteau
DONE kcodecs Aurélien Gâteau
DONE kcompletion Aurélien Gâteau
DONE kconfig Aurélien Gâteau
DONE kconfigwidgets Aurélien Gâteau
DONE kcoreaddons Aurélien Gâteau
DONE kcrash Aurélien Gâteau
DONE kdbusaddons Aurélien Gâteau
DONE kde4support Alex Merry
DONE kdeclarative ?
DONE kded Aurélien Gâteau
DONE kdesignerplugin Alex Merry
DONE kdesu ?
DONE kdewebkit ?
DONE kdnssd-framework ?
DONE kdoctools Aurélien Gâteau
DONE kemoticons ?
DONE kf5umbrella ?
DONE kfileaudiopreview Aurélien Gâteau
DONE kglobalaccel ?
DONE kguiaddons ?
DONE khtml ?
DONE ki18n ?
DONE kiconthemes ?
DONE kidletime ?
DONE kimageformats Alex Merry
IN PROGRESS kinit (refers to kdelibs 4 classes and library names, benchmarks are outdated) ?
DONE kio ?
DONE kitemmodels ?
DONE kitemviews ?
DONE kjobwidgets ?
DONE kjs ?
DONE kjsembed ?
DONE kmediaplayer ?
DONE knewstuff Aurélien Gâteau
DONE knotifications ?
DONE knotifyconfig ?
DONE kparts ?
DONE kplotting ?
DONE kprintutils ?
DONE kpty ?
DONE kross ?
DONE kservice ?
DONE ktexteditor Alex Merry
DONE ktextwidgets ?
DONE kunitconversion ?
IN PROGRESS kwallet-framework Valentin Rusu
DONE kwidgetsaddons ?
DONE kwindowsystem ?
DONE kxmlgui ?
DONE solid Aurélien Gâteau
IN PROGRESS sonnet Martin Sandsmark
DONE threadweaver ?
Retrieved from "https://community.kde.org/index.php?title=Frameworks/Epics/KF5.0_Release_Preparation/Necessary_Files&oldid=36248"