aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAdam Stück <adam@adast.xyz>2023-03-27 13:18:36 +0200
committerAdam Stück <adam@adast.xyz>2023-03-27 14:21:27 +0200
commitd9080b05e3be32abfa860c3d2cb461b57e5705e3 (patch)
treee55af03aeb98bf2357ffdae66b12347a8b379e69 /README.md
parent4782ed44fd4515e94148040f8622a51fd5c570dc (diff)
README: add project link and contributing guide
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
index 8c1ffe7..139a3f1 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,8 @@
My personal blog, built with [ssg](https://rgz.ee/ssg.html).
+[[project home]](https://sr.ht/~adamski/adast.xyz/)
+
## Build
git clone https://git.sr.ht/~adamski/adast.xyz
@@ -19,3 +21,20 @@ I run the following to publish changes to my website.
### Build & Publish
./ssg src/ dst/ adast.xyz "https://adast.xyz" && rsync -r dst/ adast.xyz:inet/adast.xyz
+
+## Contributing
+
+If you have any changes you'd like to make to SourceHut, please send a patch to
+the [adast.xyz](https://lists.sr.ht/~adamski/adast.xyz) mailing list. Feel
+free to start discussions about development here as well, if your change
+requires some thought before writing the code.
+
+### Email setup
+
+Can be done in 10-20 minutes, and you only need to learn it once.
+
+* [mailing list etiquette](https://man.sr.ht/lists.sr.ht/etiquette.md)
+* [useplaintext.mail](https://useplaintext.email/)
+
+**Patches**
+* [git-send-email.io](https://git-send-email.io/)