Skip to content

Commit 91000a5

Browse files
committed
docs: point readme to website
1 parent dcd9e3a commit 91000a5

File tree

1 file changed

+3
-96
lines changed

1 file changed

+3
-96
lines changed

README.md

Lines changed: 3 additions & 96 deletions
Original file line numberDiff line numberDiff line change
@@ -1,99 +1,6 @@
1-
# quickshell
2-
<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>
3-
4-
Flexbile QtQuick based desktop shell toolkit.
5-
6-
Hosted on: [outfoxxed's gitea], [github]
7-
8-
[outfoxxed's gitea]: https://git.outfoxxed.me/outfoxxed/quickshell
9-
[github]: https://github.com/outfoxxed/quickshell
10-
11-
Documentation available at [quickshell.outfoxxed.me](https://quickshell.outfoxxed.me) or
12-
can be built from the [quickshell-docs](https://git.outfoxxed.me/outfoxxed/quickshell-docs) repo.
13-
14-
Some fully working examples can be found in the [quickshell-examples](https://git.outfoxxed.me/outfoxxed/quickshell-examples)
15-
repo.
16-
17-
# Breaking Changes
18-
Quickshell is still in alpha and there will be breaking changes.
19-
20-
Commits with breaking qml api changes will contain a `!` at the end of the scope
21-
(`thing!: foo`) and the commit description will contain details about the broken api.
22-
23-
# Installation
24-
25-
## Nix
26-
This repo has a nix flake you can use to install the package directly:
27-
28-
```nix
29-
{
30-
inputs = {
31-
nixpkgs.url = "nixpkgs/nixos-unstable";
32-
33-
quickshell = {
34-
url = "git+https://git.outfoxxed.me/outfoxxed/quickshell";
35-
36-
# THIS IS IMPORTANT
37-
# Mismatched system dependencies will lead to crashes and other issues.
38-
inputs.nixpkgs.follows = "nixpkgs";
39-
};
40-
};
41-
}
42-
```
43-
44-
Quickshell's binary is available at `quickshell.packages.<system>.default` to be added to
45-
lists such as `environment.systemPackages` or `home.packages`.
46-
47-
The package contains several features detailed in [BUILD.md](BUILD.md) which can be enabled
48-
or disabled with overrides:
49-
50-
```nix
51-
quickshell.packages.<system>.default.override {
52-
withJemalloc = true;
53-
withQtSvg = true;
54-
withWayland = true;
55-
withX11 = true;
56-
withPipewire = true;
57-
withPam = true;
58-
withHyprland = true;
59-
}
60-
```
61-
62-
Note: by default this package is built with clang as it is significantly faster.
63-
64-
## Arch (AUR)
65-
Quickshell has a third party [AUR package] available under the same name.
66-
It is not managed by us and should be looked over before use.
67-
68-
[AUR package]: https://aur.archlinux.org/packages/quickshell
69-
70-
> [!CAUTION]
71-
> The AUR provides no way to force the quickshell package to rebuild when the Qt version changes.
72-
> If you experience crashes after updating Qt, please try rebuilding Quickshell against the
73-
> current Qt version before opening an issue.
74-
75-
## Fedora (COPR)
76-
Quickshell has a third party [Fedora COPR package] available under the same name.
77-
It is not managed by us and should be looked over before use.
78-
79-
[Fedora COPR package]: https://copr.fedorainfracloud.org/coprs/errornointernet/quickshell
80-
81-
## Guix
82-
This repo works as a channel. Add the following to your channel list:
83-
84-
```scheme
85-
(channel
86-
(name quickshell)
87-
(url "https://git.outfoxxed.me/outfoxxed/quickshell")
88-
(branch "master"))
89-
```
90-
91-
Then, you can install the package via `guix install quickshell-git` or by adding `quickshell-git` to your system or home definition.
92-
93-
You can also clone the repository and use `guix shell -f quickshell.scm` to try out the package.
94-
95-
## Anything else
96-
See [BUILD.md](BUILD.md) for instructions on building and packaging quickshell.
1+
# Quickshell
2+
See the [website](https://quickshell.outfoxxed.me) for more information
3+
and installation instructions.
974

985
# Contributing / Development
996
See [CONTRIBUTING.md](CONTRIBUTING.md) for details.

0 commit comments

Comments
 (0)