docs: mention quickshell-examples in README

This commit is contained in:
outfoxxed 2024-03-08 04:40:21 -08:00
parent f5d3457815
commit 25409d242c
Signed by: outfoxxed
GPG key ID: 4C88A185FB89301E
4 changed files with 21 additions and 1 deletions

View file

@ -10,6 +10,22 @@ Hosts: [outfoxxed's gitea], [github]
Documentation can be built from the [quickshell-docs](https://git.outfoxxed.me/outfoxxed/quickshell-docs) repo,
though is currently pretty lacking.
Some fully working examples can be found in the [quickshell-examples](https://git.outfoxxed.me/outfoxxed/quickshell-examples)
repo.
Both the documentation and examples are included as submodules with revisions that work with the current
version of quickshell.
You can clone everything with
```
$ git clone --recursive https://git.outfoxxed.me/outfoxxed/quickshell.git
```
Or clone missing submodules later with
```
$ git submodule update --init --recursive
```
# Installation
## Nix