Difference between revisions of "Frameworks/Epics/KF5.0 Release Preparation/Necessary Files"

Line 5: Line 5:
## Introduction
## Introduction
Line 12: Line 14:
## Links
## Links
- Home page: <https//projects.kde.org/projects/frameworks/@[email protected]
- Mailing list: <https://mail.kde.org/mailman/listinfo/kde-frameworks-devel>
- Mailing list: <https://mail.kde.org/mailman/listinfo/kde-frameworks-devel>
- IRC channel: #kde-devel on Freenode
- IRC channel: #kde-devel on Freenode

Revision as of 20:16, 12 January 2014


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:

# @[email protected]

@One-line [email protected]

## Introduction

@Description of the [email protected]

## Links

- Home page: <https//projects.kde.org/projects/frameworks/@[email protected]
- 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/@[email protected]/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
TO DO kdeclarative ? <{{{3}}}>
DONE kded Aurélien Gâteau
DONE kdesignerplugin Alex Merry
TO DO kdesu ? <{{{3}}}>
TO DO kdewebkit ? <{{{3}}}>
TO DO kdnssd-framework ? <{{{3}}}>
DONE kdoctools Aurélien Gâteau
TO DO kemoticons ? <{{{3}}}>
TO DO kf5umbrella ? <{{{3}}}>
DONE kfileaudiopreview Aurélien Gâteau
TO DO kglobalaccel ? <{{{3}}}>
TO DO kguiaddons ? <{{{3}}}>
TO DO khtml ? <{{{3}}}>
TO DO ki18n ? <{{{3}}}>
TO DO kiconthemes ? <{{{3}}}>
TO DO kidletime ? <{{{3}}}>
DONE kimageformats Alex Merry
TO DO kio ? <{{{3}}}>
TO DO kitemmodels ? <{{{3}}}>
TO DO kitemviews ? <{{{3}}}>
TO DO kjobwidgets ? <{{{3}}}>
TO DO kjs ? <{{{3}}}>
TO DO kjsembed ? <{{{3}}}>
TO DO kmediaplayer ? <{{{3}}}>
DONE knewstuff Aurélien Gâteau
TO DO knotifications ? <{{{3}}}>
TO DO knotifyconfig ? <{{{3}}}>
TO DO kparts ? <{{{3}}}>
TO DO kplotting ? <{{{3}}}>
TO DO kprintutils ? <{{{3}}}>
TO DO kpty ? <{{{3}}}>
TO DO kross ? <{{{3}}}>
TO DO kservice ? <{{{3}}}>
DONE ktexteditor Alex Merry
TO DO ktextwidgets ? <{{{3}}}>
TO DO kunitconversion ? <{{{3}}}>
TO DO kwallet-framework ? <{{{3}}}>
TO DO kwidgetsaddons ? <{{{3}}}>
TO DO kwindowsystem ? <{{{3}}}>
TO DO kxmlgui ? <{{{3}}}>
IN PROGRESS plasma-framework ?
DONE solid Aurélien Gâteau
IN PROGRESS sonnet Martin Sandsmark
TO DO threadweaver ? <{{{3}}}>

This page was last edited on 12 January 2014, at 20:16. Content is available under Creative Commons License SA 4.0 unless otherwise noted.