docs: mention quickshell-examples in README

This commit is contained in:
outfoxxed committed 2024-03-08 05:11:14 -08:00
1 parent f5d3457815
commit 25409d242c
4 files changed
+21 -1

No files matched your search

+3
View File
@@ -1,3 +1,6 @@
[submodule "docs"]
path = docs
url = https://git.outfoxxed.me/outfoxxed/quickshell-docs
[submodule "examples"]
path = examples
url = https://git.outfoxxed.me/outfoxxed/quickshell-examples
+16
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
+1 -1
Submodule docs updated: 32aae34d4b...70989dc619.
Submodule
+1
Submodule examples added at bc279df183.