Difference between revisions of "Kirigami"

Jump to: navigation, search
(Reserve page for Kirigami project)
 
(Copied from https://techbase.kde.org/Kirigami (with slight modification))
Line 1: Line 1:
 
{{Note | Placeholder page for future Kirigami project landing page}}
 
{{Note | Placeholder page for future Kirigami project landing page}}
 +
 +
= Introduction =
 +
 +
[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 [[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 this [[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.
 +
 +
= Get in Touch =
 +
 +
Have a burning question about Kirigami? You can find us up on the Freenode IRC server at the [http://webchat.freenode.net/?channels=kde-kirigami #kde-kirigami] channel or on
 +
[https://telegram.me/joinchat/BbOuVj6l7b5aZ_WbupyFFw Telegram] and [https://webchat.kde.org/#/room/#kirigami:kde.org Matrix] (channels are bridged and messages are mirrored to each other).
 +
 +
The team also has a shiny new [https://mail.kde.org/mailman/listinfo/kirigami dedicated mailing list] for all things Kirigami, but older emails have also been archived on the  [https://mail.kde.org/mailman/listinfo/kde-devel KDE] and [https://mail.kde.org/mailman/listinfo/plasma-devel Plasma] development mailing lists as well.
 +
 +
For bugs, please use the KDE [https://bugs.kde.org/describecomponents.cgi?product=frameworks-kirigami bug tracker] so we can keep tabs on issues better.
 +
 +
= Important Links =
 +
 +
* Source Code:
 +
** [https://cgit.kde.org/kirigami.git/ Kirigami Git repository]
 +
** [https://cgit.kde.org/kirigami-gallery.git/ Kirigami Gallery Git repository]
 +
** [https://download.kde.org/stable/frameworks/ KDE Frameworks tarballs]
 +
* Documentation
 +
**  [https://api.kde.org/kirigami/html/index.html API documentation]
 +
** '''Coming Soon''' Kirigami Documentaiton
 +
** [https://hig.kde.org/ KDE Human Interface Guidelines]
 +
* Communication
 +
** IRC: [http://webchat.freenode.net/?channels=kde-kirigami #kde-kirigami on irc.freenode.net]
 +
** Telegram: [https://telegram.me/joinchat/BbOuVj6l7b5aZ_WbupyFFw Telegram group]
 +
** Matrix: [https://webchat.kde.org/#/room/#kirigami:kde.org Kirigami on Matrix]
 +
** Mailing lists:
 +
*** [https://mail.kde.org/mailman/listinfo/kirigami Main Kirigami mailing list]
 +
*** [https://mail.kde.org/mailman/listinfo/kde-devel Mailing list for general KDE development discussion]
 +
*** [https://mail.kde.org/mailman/listinfo/plasma-devel Former mailing list for Kirigami development]
 +
** Bugs: https://bugs.kde.org/ KDE Bug tracker]

Revision as of 04:16, 1 June 2019

Note-box-icon.png
Note
Placeholder page for future Kirigami project landing page


Introduction

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 Qt Quick Controls 2 with larger application building blocks, following the design philosophy laid out in the 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 Google Play Store. The source code of kirigami-gallery can be found at this Git repository.

Kirigami uses CMake as its build system of choice. If you're unfamiliar with CMake, the CMake Manual for Qt is a good starting point to learn more about it.

Get It!

Kirigami is part of 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 download.kde.org. If you want to get the latest version of the source code, you can clone Kirigami from this Git repository. Check out this 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 KDE's API Documentation website. Kirigami also follows KDE's Human Interface Guidelines for its visual appearance and behavior.

COMING SOON: Kirigami Documentation. Watch this space.

Get in Touch

Have a burning question about Kirigami? You can find us up on the Freenode IRC server at the #kde-kirigami channel or on Telegram and Matrix (channels are bridged and messages are mirrored to each other).

The team also has a shiny new dedicated mailing list for all things Kirigami, but older emails have also been archived on the KDE and Plasma development mailing lists as well.

For bugs, please use the KDE bug tracker so we can keep tabs on issues better.

Important Links


Content is available under Creative Commons License SA 4.0 unless otherwise noted.