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

# Quickstart

Quickstart guide for using Kore.

Make sure you have installed the Kore library into your project:

```kotlin
implementation("io.github.dev778g-me:kore:1.0.0-alpha01")
```

Download and install the Kore companion app or web app.

<figure><img src="/files/JZdf4MvtzDZVKvd7IfgI" alt="companion app"><figcaption></figcaption></figure>

Although Kore comes with default themes `KoreDefaults`, you can customize it using the Kore Companion app **ThemeBuilder**. From there, choose color schemes for dark and light mode, shapes, and sizes — then hit export and you get your `theme.kt` file.

<figure><img src="/files/4c3LSPXD9CL1lwJVEeBW" alt="Customizing"><figcaption></figcaption></figure>

Replace your project's `theme.kt` (which comes by default with Material Theme) or add this file directly to your project.

<figure><img src="/files/h5wdEX3ZfVTQnj9rIxnW" alt="export theme"><figcaption></figcaption></figure>

Wrap your main content with `AppTheme` (renameable inside `theme.kt`) and you're all set.

{% columns %}
{% column %}

<figure><img src="/files/n1fFziqtGBHBixCW9ikG" alt="Material Theme"><figcaption></figcaption></figure>
{% endcolumn %}

{% column %}

<figure><img src="/files/NFBbv5g5f0NbqxJvBoD0" alt="App Theme"><figcaption></figcaption></figure>
{% endcolumn %}
{% endcolumns %}

*Happy building 😻*


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://kore-1.gitbook.io/kore/documentation/getting-started/quickstart.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.