2
1
Fork 0

docs: add build instructions to README

This commit is contained in:
outfoxxed 2024-03-07 06:18:28 -08:00
parent adead138b0
commit 32aae34d4b
Signed by: outfoxxed
GPG key ID: 4C88A185FB89301E

18
README.md Normal file
View file

@ -0,0 +1,18 @@
# quickshell-docs
Documentation for [quickshell](https://git.outfoxxed.me/outfoxxed/quickshell).
# Building the documentation
The docs depend on:
- just
- hugo
- rust
To build the documentation you must be in a subdirectory of the main quickshell repo,
which is where the submodule clones this repo.
Run the following command to build and serve the docs locally:
```
$ just serve
```