aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGabriel A. Giovanini <mail@gabrielgio.me>2024-10-05 13:40:31 +0200
committerGabriel A. Giovanini <mail@gabrielgio.me>2024-10-05 13:40:31 +0200
commit306a8cdf6fac4e3ec2bfeda6c9952f603a5577e1 (patch)
treed7134df0cf43a3235603166a14e717f6faf5337d /README.md
parent3a1359b3ad03b2fdb3b9dc0df8629834f7419a08 (diff)
downloadcerrado-306a8cdf6fac4e3ec2bfeda6c9952f603a5577e1.tar.gz
cerrado-306a8cdf6fac4e3ec2bfeda6c9952f603a5577e1.tar.bz2
cerrado-306a8cdf6fac4e3ec2bfeda6c9952f603a5577e1.zip
doc: Add more info about contributing
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md
index 3f1a12e..267a306 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,10 @@
Self host single user mail based forge.
+You can find a running instance here:
+
+https://beta.gabrielgio.me
+
### Goals
Keep it simple and lightweight, that includes the application itself,
@@ -21,6 +25,28 @@ including its statics file, is bundled into a single binary.
To run the project you just need to do a make run.
+### Installations
+
+The only installation process available so far is through my apk
+repository[^2][^3].
+
+You can check openrc files for the details how it is run, but in general you'd
+need the cerrado binary and scfg file. I can easily be integration with
+systemd.
+
+### Contributing
+
+To discuss about the project send me a email or write an issue on codeberg[^4].
+To avoid duplicated work or to work something I might not take in, I'd
+recommend to reach me before doing something.
+
+To contribute code feel free to create a PR on codeberg or send me an
+email-patch[^5].
+
+My email:
+
+mail@gabrielgio.me
+
### TODO
- Impove diff display
@@ -37,3 +63,7 @@ To run the project you just need to do a make run.
page based on its reference hash.
[^1]: https://git.sr.ht/~emersion/scfg
+[^2]: https://apkdoc.gabrielgio.me/
+[^3]: https://git.gabrielgio.me/apkbuilds/
+[^4]: https://codeberg.org/gabrielgio/cerrado/issues
+[^5]: https://git-send-email.io/