Compare commits

..

No commits in common. "1271c0ad6b26b1238ca266faaa427385d3370567" and "1cc0827946120201cd8389e0b9d409c391aa9de7" have entirely different histories.

2 changed files with 4 additions and 39 deletions

View file

@ -16,15 +16,15 @@ const videos = [
author: '<a href="https://github.com/pfaj/">pfaj</a> and <a href="https://github.com/bdebiase">bdebiase</a>',
path: "/assets/showcase/pfaj-bdeblase.mp4",
},
{
author: '<a href="https://vaxry.net">vaxry</a>',
path: "/assets/showcase/vaxry.mp4",
},
{
author: '<a href="https://github.com/flickowoa">flicko</a>',
source: "https://github.com/flickowoa/zephyr",
path: "/assets/showcase/flicko.mp4",
},
{
author: '<a href="https://vaxry.net">vaxry</a>',
path: "/assets/showcase/vaxry.mp4",
},
];
---
<div class="marquee">

View file

@ -1,35 +0,0 @@
---
title: "Distributing Configurations"
index: 9
---
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.
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
want to include a package that builds a specific Quickshell revision with
your configuration.
### Configuration Paths
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>`).
You should not use the bare `$XDG_CONFIG_HOME/quickshell` directory as that will
make it harder for users to have any other configuration.
#### As a package
Some configurations are distributed as distro packages. These packages should use a
path in `$XDG_CONFIG_DIRS`, usually `/etc/xdg` for their files.
As with dotfiles, named configurations should be used (`$CONFIG_DIR/quickshell/<name>`).