proofreading and tweaks

This commit is contained in:
starchglazer 2025-06-18 21:17:00 +08:00 committed by outfoxxed
parent 58eba03e3f
commit 403dc6d424
Signed by: outfoxxed
GPG key ID: 4C88A185FB89301E
7 changed files with 206 additions and 194 deletions

View file

@ -8,7 +8,8 @@ index: 0
## Installation
All packages currently track quickshell's master branch. This may change in the future.
Since Quickshell 0.1, you can now choose whether to install by tracking the master branch,
or install by latest release.
Note that you may want to install some additional packages (names vary by distro):
- `qtsvg`: support for SVG image loading (bundled with most packages)
@ -17,12 +18,13 @@ Note that you may want to install some additional packages (names vary by distro
- `qt5compat`: extra visual effects, notably gaussian blur. @@QtQuick.Effects.MultiEffect is usually preferable
### Nix
Quickshell releases are packaged in nixpkgs as `quickshell`.
The Quickshell repo has an embedded flake. You can use either of the two:
The Quickshell repo also has an embedded flake.
You can use either `git+https://git.outfoxxed.me/outfoxxed/quickshell`
or `github:quickshell-mirror/quickshell`. Use `?ref=` to specify a tag
if you want a tagged release.
- `git+https://git.outfoxxed.me/outfoxxed/quickshell`
- `github:quickshell-mirror/quickshell`
> [!NOTE]
> You can use `?ref=` to specify a tag if you want a tagged release.
```nix
{
@ -41,20 +43,19 @@ if you want a tagged release.
}
```
The package is available as `quickshell.packages.<system>.default`, which you can add to
`environment.systemPackages` or `home.packages` if you use home-manager.
The package is available as `quickshell.packages.<system>.default`, which can be added to
your `environment.systemPackages` or `home.packages` if you use home-manager.
### Arch
Quickshell is available from the aur under
the [quickshell](https://aur.archlinux.org/packages/quickshell) package for the latest release,
or the [quickshell-git](https://aur.archlinux.org/packages/quickshell-git) package
which tracks the master branch.
Quickshell is available from the aur under:
- the [quickshell](https://aur.archlinux.org/packages/quickshell) package for the latest release
- the [quickshell-git](https://aur.archlinux.org/packages/quickshell-git) package that tracks the master branch
> [!WARNING]
> When using an AUR package, quickshell may break any time Qt is updated.
> When using an AUR package, Quickshell may break whenever Qt is updated.
> The AUR gives us no way to actually fix this, but Quickshell will attempt to
> warn you if it detects a breakage when updating. If warned of a breakage,
> please reinstall the package
> please reinstall the package.
Install using the command below:
```sh
@ -65,9 +66,9 @@ yay -S quickshell-git
(or your AUR helper of choice)
### Fedora
Quickshell is available from the [errornointernet/quickshell] COPR, as either
`quickshell` which tracks the latest release or `quickshell-git` which tracks
the master branch.
Quickshell is available from the [errornointernet/quickshell] COPR, as either:
- `quickshell` that tracks the latest release
- `quickshell-git` that tracks the master branch
[errornointernet/quickshell]: https://copr.fedorainfracloud.org/coprs/errornointernet/quickshell
@ -90,7 +91,8 @@ Quickshell's source repository works as a channel. Add the following to your cha
(branch "master"))
```
Then, you can install the package via `guix install quickshell-git` or by adding `quickshell-git` to your system or home definition.
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.
@ -172,13 +174,13 @@ We are aware of the following issues:
- Qmlls does not work well when a file is not correctly structured.
This means that completions and lints won't work unless braces are closed
correctly and such.
- Qmlls cannot handle quickshell's singletons. This means you won't see
completions, and usages of singleton members may show a warning.
We're still investigating this problem and how to fix it.
- Qmlls cannot handle Quickshell's Singleton, which means you won't see completions,
and usages of Singleton members may show a warning. We're still investigating
this problem and how to fix it.
- The LSP cannot provide any documentation for Quickshell types.
Keeping in mind the above caveats, qmlls should be able to guide you towards
more correct code should you chose to use it.
Keeping in mind the above caveats, qmlls should be able to guide you towards a
more correct code should you choose to use it.
> [!NOTE]
> Nix users should note that qmlls will not be able to pick up qml modules