Simple and flexbile QtQuick based desktop shell toolkit.
Find a file
2024-06-02 14:50:23 -07:00
docs@ff5da84a8b service/pipewire: add pipewire module 2024-05-19 02:29:21 -07:00
examples@b9e744b506 core/transformwatcher: add TransformWatcher 2024-04-17 04:31:02 -07:00
src core/reloader: fix crashing on failed reload 2024-05-31 04:03:00 -07:00
.clang-format feat(wayland): custom layershell implementation 2024-02-24 02:06:40 -08:00
.clang-tidy service/pipewire: add pipewire module 2024-05-19 02:29:21 -07:00
.editorconfig feat: begin work on docs, also minor refactoring 2024-02-12 16:00:42 -08:00
.gitignore docs: add build instructions to README 2024-03-07 06:19:09 -08:00
.gitmodules docs: mention quickshell-examples in README 2024-03-08 05:11:14 -08:00
BUILD.md docs: add build, packaging and development instructions 2024-06-02 14:50:23 -07:00
CMakeLists.txt build: link jemalloc by default to reduce heap fragmentation 2024-05-31 01:28:35 -07:00
CONTRIBUTING.md docs: add build, packaging and development instructions 2024-06-02 14:50:23 -07:00
default.nix build: link jemalloc by default to reduce heap fragmentation 2024-05-31 01:28:35 -07:00
flake.lock build: nix packaging 2024-03-04 05:13:58 -08:00
flake.nix nix: fix git revision in nix package 2024-04-08 00:35:49 -07:00
Justfile build: improve parallelism by removing core dependency on modules 2024-03-12 00:04:20 -07:00
LICENSE misc: add LGPL license 2024-03-04 06:10:03 -08:00
LICENSE-GPL misc: add LGPL license 2024-03-04 06:10:03 -08:00
README.md docs: add build, packaging and development instructions 2024-06-02 14:50:23 -07:00
shell.nix build: greatly speed up build times using pch 2024-03-11 18:18:55 -07:00

quickshell

Simple and flexbile QtQuick based desktop shell toolkit.

Hosted on: outfoxxed's gitea, github

Documentation available at quickshell.outfoxxed.me or can be built from the quickshell-docs repo.

Some fully working examples can be found in the quickshell-examples repo.

Both the documentation and examples are included as submodules with revisions that work with the current version of quickshell.

You can clone everything with

$ git clone --recursive https://git.outfoxxed.me/outfoxxed/quickshell.git

Or clone missing submodules later with

$ git submodule update --init --recursive

Installation

Nix

This repo has a nix flake you can use to install the package directly:

{
  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 which can be enabled or disabled with overrides:

quickshell.packages.<system>.default.override {
  enableWayland = true;
  enableX11 = true;
  enablePipewire = true;
  withQtSvg = true;
  withJemalloc = true;
}

Note: by default this package is built with clang as it is significantly faster.

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.

Anything else

See BUILD.md for instructions on building and packaging quickshell.

Contributing / Development

See CONTRIBUTING.md for details.

License

Licensed under the GNU LGPL 3.
Unless you explicitly state otherwise, any contribution submitted for inclusion shall be licensed as above, without any additional terms or conditions.