summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..93a9766
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# Source code for my personal website
+
+### About
+
+This repository contains the source code for my personal website
+available at [https://adbjesus.com].
+
+### Build
+
+First install [Zola](https://getzola.org) on your system. Then, run
+`zola build` to build the website to the `public/` folder for
+deployment, or run `zola serve` to serve it locally.
+
+##### Nix
+
+If you're using nix (with flakes), you can run `nix develop` to get a
+development shell with everything that is needed. You can also use
+`nix build` to build the website, or `nix run` to serve locally.
+
+### License
+
+The source code of the website is under the MIT License, and available
+at <https://git.adbjesus.com/website>.
+
+The contents of the website are licensed under the [CC BY-SA
+4.0](https://creativecommons.org/licenses/by-sa/4.0) license, except
+for the PDFs in the `content/publications` folder or if otherwise
+explicitly noted.