aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorA Farzat <a@farzat.xyz>2024-11-23 22:38:24 +0900
committerA Farzat <a@farzat.xyz>2024-11-23 22:38:24 +0900
commitdca9703153b3b6fbaaa2ea465aaeb6a01248a0dc (patch)
tree0bac23694adbe823947899d423066b27cd02f6db
parent85a545da0f5d1c49c6ad3f593b1b3208fbc91717 (diff)
downloadfarzat.xyz-dca9703153b3b6fbaaa2ea465aaeb6a01248a0dc.tar.gz
farzat.xyz-dca9703153b3b6fbaaa2ea465aaeb6a01248a0dc.zip
Add readmemaster
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bd734ce
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# [My website](https://farzat.xyz)
+
+This is the source code for [my website](https://farzat.xyz). It is written so
+that it can be compiled by [Zola](https://www.getzola.org/) and used directly
+on a web server.
+
+The code is distributed under the AGPLv3, allowing you to modify it and use it
+if you wish. If you make any improvements, please don't hesitate to send a
+patch on [the mailing list](https://lists.sr.ht/~farzat/farzat.xyz-devel). If
+you don't know how to, [here is a simple guide](https://git-send-email.io/).
+Otherwise, you could open a pull request on either
+[GitHub](https://github.com/Farzat07/farzat.xyz) or
+[GitLab](https://gitlab.com/Farzat07/farzat.xyz). For security vulnerabilities,
+make sure to [email them directly](mailto:a@farzat.xyz), though this might
+sound like an overkill for a static website.
+
+This website was designed with both desktop and mobile in mind. If the website
+doesn't work properly on your device, please open a ticket
+[here](https://todo.sr.ht/~farzat/farzat.xyz).