diff --git a/Kirigami/source/gettingstarted/deployment/android.rst b/Kirigami/source/gettingstarted/deployment/android.rst new file mode 100644 index 0000000..015ff51 --- /dev/null +++ b/Kirigami/source/gettingstarted/deployment/android.rst @@ -0,0 +1,4 @@ +Deploying on Android +==================== + +[TODO] diff --git a/Kirigami/source/gettingstarted/deployment/index.rst b/Kirigami/source/gettingstarted/deployment/index.rst new file mode 100644 index 0000000..9ad7dfa --- /dev/null +++ b/Kirigami/source/gettingstarted/deployment/index.rst @@ -0,0 +1,19 @@ +Deployment +========== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + linux + android + windows + +Depending how the app was built, there can be several ways to deploy the +application on the target system [TODO] + + +* :doc:`linux` +* :doc:`android` +* :doc:`windows` + diff --git a/Kirigami/source/gettingstarted/deployment/linux.rst b/Kirigami/source/gettingstarted/deployment/linux.rst new file mode 100644 index 0000000..a286440 --- /dev/null +++ b/Kirigami/source/gettingstarted/deployment/linux.rst @@ -0,0 +1,4 @@ +Deploying on Linux +================== + +[TODO] diff --git a/Kirigami/source/gettingstarted/deployment/windows.rst b/Kirigami/source/gettingstarted/deployment/windows.rst new file mode 100644 index 0000000..27f3f19 --- /dev/null +++ b/Kirigami/source/gettingstarted/deployment/windows.rst @@ -0,0 +1,4 @@ +Deploying on Windows +==================== + +[TODO] diff --git a/Kirigami/source/gettingstarted/firstkirigamiproject/cmakedynamic.rst b/Kirigami/source/gettingstarted/firstkirigamiproject/cmakedynamic.rst new file mode 100644 index 0000000..bfda131 --- /dev/null +++ b/Kirigami/source/gettingstarted/firstkirigamiproject/cmakedynamic.rst @@ -0,0 +1,4 @@ +CMake with dynamic linking +============ + +[TODO] diff --git a/Kirigami/source/gettingstarted/firstkirigamiproject/cmakestatic.rst b/Kirigami/source/gettingstarted/firstkirigamiproject/cmakestatic.rst new file mode 100644 index 0000000..b413661 --- /dev/null +++ b/Kirigami/source/gettingstarted/firstkirigamiproject/cmakestatic.rst @@ -0,0 +1,4 @@ +CMake with static linking +============ + +[TODO] diff --git a/Kirigami/source/gettingstarted/firstkirigamiproject/index.rst b/Kirigami/source/gettingstarted/firstkirigamiproject/index.rst new file mode 100644 index 0000000..e830bf3 --- /dev/null +++ b/Kirigami/source/gettingstarted/firstkirigamiproject/index.rst @@ -0,0 +1,38 @@ +First Kirigami Project +====================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + cmakedynamic + cmakestatic + qmakestatic + + +Kirigami can be used in your project in different ways, depending from the +build system and the deployment needs. + +CMake +----- +CMake is the recommended build system for Kirigami based applications. It can +be built and used in two ways +- Dynamic: This is the preferred way. Kirigami is built and linked as a dynamic +plugin and library. Usually system packages of Kirigami are used, tough this +mode can also be used with containerized solutions such as flatpak, Snap and +Appimage. +- Static: Kirigami is statically linked inside the application executable: it +simplified deployment but some features are lost. It is not recommended to use +this for deployment on Linux desktop systems. + +* :doc:`cmakedynamic` +* :doc:`cmakestatic` + +QMake +----- +The Kirigami dynamic build can also be used from a qmake-based project. +QMake can also be used to statically build and link Kirigami into a qmake-based +project. + +* :doc:`qmakestatic` + diff --git a/Kirigami/source/gettingstarted/firstkirigamiproject/qmakestatic.rst b/Kirigami/source/gettingstarted/firstkirigamiproject/qmakestatic.rst new file mode 100644 index 0000000..04aba60 --- /dev/null +++ b/Kirigami/source/gettingstarted/firstkirigamiproject/qmakestatic.rst @@ -0,0 +1,4 @@ +QMake with static linking +============ + +[TODO] diff --git a/Kirigami/source/gettingstarted/index.rst b/Kirigami/source/gettingstarted/index.rst new file mode 100644 index 0000000..1538c25 --- /dev/null +++ b/Kirigami/source/gettingstarted/index.rst @@ -0,0 +1,14 @@ +Getting Started +=============== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + firstkirigamiproject/index + deployment/index + + +[TODO] DEscription of the section + + diff --git a/Kirigami/source/index.rst b/Kirigami/source/index.rst index 24ea8a0..b18045f 100644 --- a/Kirigami/source/index.rst +++ b/Kirigami/source/index.rst @@ -1,50 +1,53 @@ .. Kirigami documentation master file, created by sphinx-quickstart on Mon Apr 15 08:55:06 2019. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. Introducing Kirigami UI ======================= .. toctree:: :maxdepth: 2 :caption: Contents: + introduction/index + gettingstarted/index + navigation/index style/index Build apps that adapt beautifully to mobile, desktop, and everything in between. Convergent ---------- The line between desktop and mobile is blurring, and users expect the same quality experience on every device. Applications using Kirigami adapt brilliantly to mobile, desktop, and everything in between. See :doc:`convergence in the HIG ` for more details. Responsive ---------- Kirigami apps adapt to more than just the devices we use them on, always offering the optimal layout depending on how they are used by your audience. See :doc:`responsive in the HIG ` for more details. Elegant ------- Kirigami is smooth and animated, uses consistent components, and a clearly defined workflow. People using Kirigami will appreciate the smart workflow and no-gimmick design. Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` diff --git a/Kirigami/source/introduction/architecture.rst b/Kirigami/source/introduction/architecture.rst new file mode 100644 index 0000000..6018314 --- /dev/null +++ b/Kirigami/source/introduction/architecture.rst @@ -0,0 +1,4 @@ +Architecture +============ + +[TODO] diff --git a/Kirigami/source/introduction/convergence.rst b/Kirigami/source/introduction/convergence.rst new file mode 100644 index 0000000..94a7ec3 --- /dev/null +++ b/Kirigami/source/introduction/convergence.rst @@ -0,0 +1,10 @@ +Optimized Convergence +===================== + +The design of KDE software, and by extension the Kirigami Framework, is made +with +convergence in mind. *Convergence* means that a piece of software's user +interface can immediately adapt its user experience to the particularities of +each type of device that it can run on (desktop, laptop, tablet, phone, etc). + +The Kirigami api offers several facilities to achieve this goal [TODO] diff --git a/Kirigami/source/introduction/devicetypes.rst b/Kirigami/source/introduction/devicetypes.rst new file mode 100644 index 0000000..44261ff --- /dev/null +++ b/Kirigami/source/introduction/devicetypes.rst @@ -0,0 +1,21 @@ +Device Types +============ + +In today's world, there are many types of digital devices: desktop and laptop +computers, smartphones, tablets, and so on. A harmonious and efficient user +experience is only possible when the software's user interface is tailored to +each device's physical characteristics and the way that a user will interact +with it. + +For information regarding the differences between a user interface and the user experience, see the :doc:`../resources/glossary`. + +Some devices are adaptable, e.g. a tablet with a keyboard plugged in, or a +convertible laptop with only the touchscreen in use. These types of devices +will require the user interface to adapt as necessary for each usage mode. +If minimal changes are needed (for example, a laptop plugged into a large +external screen) this can be achieved with a "responsive" design, as described +in :doc:`responsive`. For more extensive changes (for example, a tablet +plugged into a docking station with a mouse and keyboard attached), an entirely +different user interface paradigm may need to be presented. + +[TODO] Notable differences in behavior of kirigami on different types diff --git a/Kirigami/source/introduction/index.rst b/Kirigami/source/introduction/index.rst new file mode 100644 index 0000000..9b342cd --- /dev/null +++ b/Kirigami/source/introduction/index.rst @@ -0,0 +1,17 @@ +Introduction +======================= + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + architecture + convergence + devicetypes + + +[TODO] High level overview + +* :doc:`architecture` +* :doc:`convergence` +* :doc:`devicetypes` diff --git a/Kirigami/source/navigation/index.rst b/Kirigami/source/navigation/index.rst new file mode 100644 index 0000000..a99f47d --- /dev/null +++ b/Kirigami/source/navigation/index.rst @@ -0,0 +1,14 @@ +UI navigation paradigms +======================= + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + pagerow + +[TODO] introduce the PageRow style navigation, how to do a navigation sidebar +etc + +* :doc:`pagerow` + diff --git a/Kirigami/source/navigation/pagerow.rst b/Kirigami/source/navigation/pagerow.rst new file mode 100644 index 0000000..ccf7b75 --- /dev/null +++ b/Kirigami/source/navigation/pagerow.rst @@ -0,0 +1,4 @@ +PageRow +============ + +[TODO]