diff --git a/README b/README index 039c71957..512359bf6 100644 --- a/README +++ b/README @@ -1,2 +1,22 @@ -KDevelop website: http://www.kdevelop.org/ -API documentation: http://api.kde.org/extragear-api/kdevelop-apidocs/kdevplatform/html/index.html +# KDevelop Platform Libraries + +This repository contains the KDevelop Platform Libraries, a set of libraries used to create plugins for [KDevelop](https://www.kdevelop.org/) or other IDEs based on kdevplatform. + +The idea that this repository contains +- Everything to create platform plugins +- Everything to create platform applications +- Commonly used/important plugins (e.g. VCS plugins) + +## Compile + +To compile KDevelop, please refer to the Wiki instructions: +https://community.kde.org/KDevelop/HowToCompile_v5 + +## API Documentation + +API documentation is available from: +https://api.kde.org/extragear-api/kdevelop-apidocs/kdevplatform/html/index.html + +## Infrastructure +- [Bug tracker](https://bugs.kde.org/buglist.cgi?bug_status=UNCONFIRMED&bug_status=CONFIRMED&bug_status=ASSIGNED&bug_status=REOPENED&list_id=1408918&product=kdevplatform&query_format=advanced) +- [Phabricator (task tracker, code review and more)](https://phabricator.kde.org/dashboard/view/8/?)