commit 6649263ab3d1b3492e234eb21e8dbc1d5f215966
parent 5462bce295da93ccb696369479c988462946bef2
Author: FIGBERT <figbert@figbert.com>
Date: Thu, 10 Feb 2022 22:23:40 -0800
Add installation instructions
Diffstat:
1 file changed, 18 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
@@ -7,7 +7,23 @@ will be added when I stumble onto the need to make them.
All in all, it's fairly... decent.
-For more information, [check out the documentation][docs].
+## installation
+
+To use d3c3nt in your own site, you have to add it to your `themes`
+directory. You can do this in a variety of ways, but I recommend adding
+it as a git submodule:
+
+```
+$ cd themes/
+$ git submodule add https://git.figbert.com/FIGBERT/d3c3nt.git
+```
+
+After installing the theme, set the top-level `theme` variable to
+`"d3c3nt"` in your `config.toml`.
+
+For more information about Zola themes in general, check out Zola's
+[official site][zola-docs]. To find out more about d3c3nt's features and
+configuration, head over to the [project's docs][docs].
## whoami
@@ -17,6 +33,7 @@ subscribe via the [Atom feed][atom]. You can contact me via email at:
[FIGBERT]: https://figbert.com/
[zola]: https://getzola.org/
+[zola-docs]: https://www.getzola.org/documentation/themes/overview/
[docs]: https://d3c3nt.figbert.com/config/
[atom]: https://figbert.com/atom.xml
[email]: mailto:figbert+d3c3nt@figbert.com