Kirigami: Difference between revisions

From KDE TechBase
(Add documentation text and links)
(Moved to the Community Wiki)
Tag: Replaced
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
= Introduction =
This page has been moved to the [https://community.kde.org/Kirigami Community Wiki]
 
[https://kde.org/products/kirigami/ Kirigami] is KDE’s powerful but lightweight user interface framework for mobile and convergent applications. It allows Qt developers to easily create applications that run on most major mobile and desktop platforms without modification (though adapted user interfaces for different form-factors are supported and recommended for optimal user experience). It extends the touch-friendly [http://doc.qt.io/qt-5/qtquickcontrols-index.html Qt Quick Controls 2] with larger application building blocks, following the design philosophy laid out in the [https://hig.kde.org/ KDE Human Interface Guidelines].
 
You can try out Kirigami in action with the Kirigami Gallery app which is available on most Linux distributions. On Android, you can download it from [https://play.google.com/store/apps/details?id=org.kde.kirigamigallery Google Play Store]. The source code of kirigami-gallery can be found at [https://cgit.kde.org/kirigami-gallery.git/ this Git repository].
 
Kirigami uses CMake as its build system of choice. If you're unfamiliar with CMake, the [http://doc.qt.io/qt-5/cmake-manual.html CMake Manual for Qt] is a good starting point to learn more about it.
 
= Get It! =
 
Kirigami is part of [[KDE_Frameworks|KDE Frameworks]] and is released together with other frameworks every month. In most cases, you'll want to use your Linux distribution's packages. You can also find source tarballs for the latest stable releases from [https://download.kde.org/stable/frameworks/ download.kde.org]. If you want to get the latest version of the source code, you can clone Kirigami from [https://cgit.kde.org/kirigami.git/ this Git repository]. Check out the KDE Community Wiki for a [https://community.kde.org/Guidelines_and_HOWTOs/Build_from_source handy guide to building software from source].
 
= Documentation =
 
The Kirigami framework is composed of QML components as well as C++ classes that power them. Documentation for both can be found on [https://api.kde.org/frameworks/kirigami/html/index.html KDE's API Documentation] website. Kirigami also follows KDE's [https://hig.kde.org/ Human Interface Guidelines] for its visual appearance and behavior.
 
'''COMING SOON:''' Kirigami Documentation. Watch this space.
 
= Important Links =
 
* [https://cgit.kde.org/kirigami.git/ Source code repository]
* [https://api.kde.org/kirigami/html/index.html API documentation]
* [https://hig.kde.org/ Human Interface Guidelines]
* IRC: [http://webchat.freenode.net/?channels=plasma #plasma on irc.freenode.net]
* [https://telegram.me/joinchat/BbOuVj6l7b5aZ_WbupyFFw Telegram group]
* [https://mail.kde.org/mailman/listinfo/kde-devel Mailing list for questions and discussion around ''using'' Kirigami for developing a user interface]
* [https://mail.kde.org/mailman/listinfo/plasma-devel Mailing list for discussing development of Kirigami ''itself'']
* [https://bugs.kde.org/ Bug tracker]

Latest revision as of 02:10, 3 February 2023

This page has been moved to the Community Wiki