30 lines
1.3 KiB
Text
30 lines
1.3 KiB
Text
---
|
|
title: "Usage Guide"
|
|
description: "Configuring the shell"
|
|
index: -1
|
|
---
|
|
See the [Installation and Setup](/docs/guide/install-setup) page to get started.
|
|
|
|
To write a Quickshell config, start by following the
|
|
[Guided Introduction](/docs/guide/introduction), and skimming the
|
|
[QML Language Overview](/docs/guide/qml-language).
|
|
|
|
After that, read the [Item Size and Position](/docs/guide/size-position) page before
|
|
continuing on your own to learn how to lay out elements in QML. Laying out elements
|
|
in QML is significantly different from many other layout systems such as CSS.
|
|
|
|
To learn what features Quickshell offers and how to use them, use the
|
|
left sidebar and click through the `Quickshell Types` pages. The sidebar
|
|
also links QtQuick's type index, which contains most of the visual elements used
|
|
to build a UI.
|
|
|
|
You may also want to check out the [Official Examples] to see some code,
|
|
as well as review existing user configs. Do note that Quickshell has evolved
|
|
considerably over time and most configs don't reflect current best practice.
|
|
|
|
[Official Examples]: https://git.outfoxxed.me/quickshell/quickshell-examples
|
|
|
|
See also the [FAQ](/docs/guide/faq) page, and the [Matrix Space] or [Discord Server] (bridged) for help.
|
|
|
|
[Matrix Space]: https://matrix.to/#/#quickshell:outfoxxed.me
|
|
[Discord Server]: https://discord.gg/UtZeT3xNyT
|