From 25409d242cb54ec3529b7f644b9c7ff22f1b3489 Mon Sep 17 00:00:00 2001 From: outfoxxed Date: Fri, 8 Mar 2024 04:40:21 -0800 Subject: [PATCH] docs: mention quickshell-examples in README --- .gitmodules | 3 +++ README.md | 16 ++++++++++++++++ docs | 2 +- examples | 1 + 4 files changed, 21 insertions(+), 1 deletion(-) create mode 160000 examples diff --git a/.gitmodules b/.gitmodules index b3bb12cb..74013769 100644 --- a/.gitmodules +++ b/.gitmodules @@ -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 diff --git a/README.md b/README.md index 8e142309..e075a322 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs b/docs index 32aae34d..70989dc6 160000 --- a/docs +++ b/docs @@ -1 +1 @@ -Subproject commit 32aae34d4bf77f4455628bd13091474d67461527 +Subproject commit 70989dc619bcdc29dc4880b4ff5257d6ad188a18 diff --git a/examples b/examples new file mode 160000 index 00000000..bc279df1 --- /dev/null +++ b/examples @@ -0,0 +1 @@ +Subproject commit bc279df183b1628a0b0dfffc2f8f6dbd2ffdc33e