quickshell/quickshell-web
3
1
Fork 0
Code Issues Projects Activity

proofreading and tweaks

Browse source
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
Download patch file Download diff file Expand all files Collapse all files

26
src/guide/distribution.mdx
View file

@ -6,12 +6,15 @@ If you plan to distribute your configuration to a lot of users, you should keep
a couple things in mind:
### API Breaks
Quickshell will have API breaks in future versions.
You should have a way to track specific revisions with your distribution
to avoid breakage if a user updates quickshell before you can update your configuration.
As Quickshell is still in a somewhat early stage of development, Quickshell will
have API breaks for future versions.
With Nix this should be as simple as tracking a specific revision.
For Arch, and other distributions without a mechanism to do this, you may
You should have a way to track specific revisions to avoid breakage if a user
updates Quickshell before you can update your configuration.
With Nix, this should be as simple as tracking a specific revision.
For Arch, or any other distributions without a mechanism to do this, you may
want to include a package that builds a specific Quickshell revision with
your configuration.
@ -20,13 +23,14 @@ Quickshell can load configurations from a number of different paths.
The ideal path depends on how you distribute your config.
#### As dotfiles
If you distribute your config as a set of dotfiles, you should place
the config in `$XDG_CONFIG_HOME/quickshell/<name>` (usually `~/.config/quickshell/<name>`).
Named configurations can be used in the quickshell command by specifying `--config` or `-c`
(`qs -c <name>`).
If you distribute your config as a set of dotfiles, you should place it in
`$XDG_CONFIG_HOME/quickshell/<name>` (usually `~/.config/quickshell/<name>`).
You should not use the bare `$XDG_CONFIG_HOME/quickshell` directory as that will
make it harder for users to have any other configuration.
You should name your config and refrain from using the bare `$XDG_CONFIG_HOME/quickshell`
directory, as that will make it harder for users to have any other configuration.
Any directory in the `$XDG_CONFIG_HOME/quickshell` can be used using the Quickshell command
by specifying `--config` or `-c`, like so: `qs -c <name>`.
#### As a package
Some configurations are distributed as distro packages. These packages should use a