> For the complete documentation index, see [llms.txt](https://maui-project.gitbook.io/mauikit/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://maui-project.gitbook.io/mauikit/getting-started.md).

# Getting Started

**Getting Started** section describes how to include and use **MauiKit** in your existing / new project.

## **How to use the MauiKit?**

The MauiKit works as a submodule and it relies on the KDE framework Kirigami. 

It makes use of qmake to be included into your project and then be built. But you can also now make use of cmake to add it as a subdirectory and linked as a static library.

## Step 1 - Install MauiKit

MauiKit can be installed system wide to be used as a framework or be used as a submodule to be statically linked to your poject.

{% content-ref url="/pages/-LL9i4VuMSwavz1-u7c1" %}
[Installing MauiKit](/mauikit/getting-started/installing-mauikit.md)
{% endcontent-ref %}

If **MauiKit** is already installed, follow Step 2 to import and use **MauiKit** Components in the project

## Step 2 - Import MauiKit

Once you complete Step 1, you need to import **MauiKit** to your project to use the components. Use the following guide to import **MauiKit** :

{% content-ref url="/pages/-LL9i7FxmkBdopNwLCch" %}
[Importing and Including](/mauikit/getting-started/importing-mauikit-in-a-project.md)
{% endcontent-ref %}

{% hint style="success" %}
Hurray. You're ready to rock-n-roll
{% endhint %}

## Next Steps

To know more about all the components, take a look at the documentation :

{% content-ref url="/pages/-LL9iIzjj18Z0dqsYZcs" %}
[Utils](/mauikit/documentation-1/documentation.md)
{% endcontent-ref %}