diff --git a/README.md b/README.md index 8377927..adefcb8 100644 --- a/README.md +++ b/README.md @@ -1,99 +1,6 @@ -# quickshell - - -Flexbile QtQuick based desktop shell toolkit. - -Hosted on: [outfoxxed's gitea], [github] - -[outfoxxed's gitea]: https://git.outfoxxed.me/outfoxxed/quickshell -[github]: https://github.com/outfoxxed/quickshell - -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. - -Some fully working examples can be found in the [quickshell-examples](https://git.outfoxxed.me/outfoxxed/quickshell-examples) -repo. - -# Breaking Changes -Quickshell is still in alpha and there will be breaking changes. - -Commits with breaking qml api changes will contain a `!` at the end of the scope -(`thing!: foo`) and the commit description will contain details about the broken api. - -# 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"; - - # THIS IS IMPORTANT - # Mismatched system dependencies will lead to crashes and other issues. - inputs.nixpkgs.follows = "nixpkgs"; - }; - }; -} -``` - -Quickshell's binary is available at `quickshell.packages..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..default.override { - withJemalloc = true; - withQtSvg = true; - withWayland = true; - withX11 = true; - withPipewire = true; - withPam = true; - withHyprland = 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. -It is not managed by us and should be looked over before use. - -[AUR package]: https://aur.archlinux.org/packages/quickshell - -> [!CAUTION] -> The AUR provides no way to force the quickshell package to rebuild when the Qt version changes. -> If you experience crashes after updating Qt, please try rebuilding Quickshell against the -> current Qt version before opening an issue. - -## Fedora (COPR) -Quickshell has a third party [Fedora COPR package] available under the same name. -It is not managed by us and should be looked over before use. - -[Fedora COPR package]: https://copr.fedorainfracloud.org/coprs/errornointernet/quickshell - -## Guix -This repo works as a channel. Add the following to your channel list: - -```scheme -(channel - (name quickshell) - (url "https://git.outfoxxed.me/outfoxxed/quickshell") - (branch "master")) -``` - -Then, you can install the package via `guix install quickshell-git` or by adding `quickshell-git` to your system or home definition. - -You can also clone the repository and use `guix shell -f quickshell.scm` to try out the package. - -## Anything else -See [BUILD.md](BUILD.md) for instructions on building and packaging quickshell. +# Quickshell +See the [website](https://quickshell.outfoxxed.me) for more information +and installation instructions. # Contributing / Development See [CONTRIBUTING.md](CONTRIBUTING.md) for details.