jacekpoz
/
quickshell
forked from outfoxxed/quickshell
1
0
Fork 0
Code Pull Requests Activity

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 untrusted user: outfoxxed
GPG Key ID: 4C88A185FB89301E
4 changed files with 21 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.gitmodules vendored
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
README.md
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

2
docs

@ -1 +1 @@
Subproject commit 32aae34d4bf77f4455628bd13091474d67461527
Subproject commit 70989dc619bcdc29dc4880b4ff5257d6ad188a18

1
examples Submodule

@ -0,0 +1 @@
Subproject commit bc279df183b1628a0b0dfffc2f8f6dbd2ffdc33e