> 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/installing-mauikit.md).

# Installing MauiKit

The **MauiKit** can be used as a framework or as a submodule, depending on where and how you want to deploy your project.

**MauiKit** relies on the KDE framework **Kirigami**.

**MauiKit** supports *qmake* and *cmake*, you can use *qmake* to link **MauiKit** to your project and cmake to build and install Mauikit system wide.

To deploy your project in a GNU Linux system the best way to go is to build and install MauiKit system wide, making use of cmake.

To deploy your project to other systems, such as Android, the best way is to use qmake and link MauiKit to your project as a submodule.

## Get MauiKit 

**MauiKit** can be cloned as follows :

```
git clone git://anongit.kde.org/mauikit
```

## Install MauiKit 

To install **MauiKit** system wide, after cloning it just follow this commands:

```
cd mauikit
mkdir build && cd build
cmake .. -DCMAKE_INSTALL_PREFIX=/usr
make
sudo make install
```

Now that **Mauikit** is installed system wide you can start making use of it in your project, be it with *qmake* or *cmake*.

If you plan to link **MauiKit** statically, it needs to be included in your project to use its components.

 Follow this guide to include **MauiKit** into the new/existing project :

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