quickshell/README.md

79 lines
2.2 KiB
Markdown
Raw Permalink Normal View History

2024-03-04 13:49:37 +00:00
# quickshell
2024-04-02 05:46:08 +00:00
<a href="https://matrix.to/#/#quickshell:outfoxxed.me"><img src="https://img.shields.io/badge/Join%20the%20matrix%20room-%23quickshell:outfoxxed.me-0dbd8b?logo=matrix&style=flat-square"></a>
2024-03-04 13:49:37 +00:00
2024-03-04 14:17:04 +00:00
Simple and flexbile QtQuick based desktop shell toolkit.
2024-04-02 05:46:08 +00:00
Hosted on: [outfoxxed's gitea], [github]
2024-03-04 14:17:04 +00:00
[outfoxxed's gitea]: https://git.outfoxxed.me/outfoxxed/quickshell
[github]: https://github.com/outfoxxed/quickshell
2024-03-04 13:49:37 +00:00
2024-03-11 12:46:19 +00:00
Documentation available at [quickshell.outfoxxed.me](https://quickshell.outfoxxed.me) or
can be built from the [quickshell-docs](https://git.outfoxxed.me/outfoxxed/quickshell-docs) repo.
2024-03-07 14:00:46 +00:00
Some fully working examples can be found in the [quickshell-examples](https://git.outfoxxed.me/outfoxxed/quickshell-examples)
repo.
2024-03-07 14:00:46 +00:00
# Installation
## Nix
This repo has a nix flake you can use to install the package directly:
```nix
{
inputs = {
nixpkgs.url = "nixpkgs/nixos-unstable";
quickshell = {
url = "git+https://git.outfoxxed.me/outfoxxed/quickshell";
inputs.nixpkgs.follows = "nixpkgs";
};
};
}
```
Quickshell's binary is available at `quickshell.packages.<system>.default` to be added to
lists such as `environment.systemPackages` or `home.packages`.
The package contains several features detailed in [BUILD.md](BUILD.md) which can be enabled
or disabled with overrides:
```nix
quickshell.packages.<system>.default.override {
withJemalloc = true;
withQtSvg = true;
withWayland = true;
withX11 = true;
withPipewire = true;
withHyprland = true;
}
2024-03-07 14:00:46 +00:00
```
Note: by default this package is built with clang as it is significantly faster.
2024-03-07 14:00:46 +00:00
## Arch (AUR)
Quickshell has a third party [AUR package] available under the same name.
As is usual with the AUR it is not maintained by us and should be looked over before use.
2024-03-07 14:00:46 +00:00
[AUR package]: https://aur.archlinux.org/packages/quickshell
2024-03-07 14:00:46 +00:00
## Anything else
See [BUILD.md](BUILD.md) for instructions on building and packaging quickshell.
2024-03-07 14:00:46 +00:00
# Contributing / Development
See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
2024-03-07 14:00:46 +00:00
2024-03-04 13:49:37 +00:00
#### License
<sup>
Licensed under the GNU LGPL 3.
</sup>
<br>
<sub>
Unless you explicitly state otherwise, any contribution submitted
for inclusion shall be licensed as above, without any additional
terms or conditions.
</sub>