From 042f17732fefac295ce57ea2c5be60e7fed9f38e Mon Sep 17 00:00:00 2001
From: EuAndreh <eu@euandre.org>
Date: Sat, 12 Jun 2021 13:37:21 -0300
Subject: README.md: Dump default metadata information

---
 README.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/README.md b/README.md
index 6682fae..74c3517 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,32 @@
 # git-permalink
 
 Git extension to generate web permalinks of files in a repository.
+
+For running the extra development-only checks, run:
+
+```shell
+$ make dev-check
+```
+
+and for generating the documentation HTML and website, run:
+
+```shell
+$ make public
+```
+
+
+## Links
+
+- [home page](https://euandreh.xyz/git-permalink/)
+- [source code](https://git.euandreh.xyz/git-permalink/)
+- [bug tracking](https://euandreh.xyz/git-permalink/TODOs.html)
+- [mailing list](https://lists.sr.ht/~euandreh/public-inbox?search=%5Bgit-permalink%5D)
+- [CI logs](https://euandreh.xyz/git-permalink/ci.html)
+- [CHANGELOG](https://euandreh.xyz/git-permalink/CHANGELOG.html)
+
+
+## License
+
+The code is licensed under [GNU Affero General Public License v3.0 or later][AGPL-3.0-or-later] (AGPL-3.0-or-later).
+
+[AGPL-3.0-or-later]: https://www.gnu.org/licenses/agpl-3.0.en.html
-- 
cgit v1.2.3