aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPhilip Kaludercic <philipk@posteo.net>2022-08-25 16:10:23 +0200
committerPhilip Kaludercic <philipk@posteo.net>2022-08-25 16:10:23 +0200
commitc6e6af42519d4c0759bb0d908134f980cdbfb0db (patch)
tree2ad034955239c971a357b836fe40e50ca2eb941b /README.md
parentce2fecf94eb3f27851567237a65251dbb419de4b (diff)
Break link reference definitions into two lines
According to the commonmark spec [0], this is allowed. I prefer it because it makes reading the labels and URLs easier, especially when a block has multiple labels of varying lengths where tabulating wouldn't make much sense. [0] https://spec.commonmark.org/0.30/#link-reference-definition
Diffstat (limited to 'README.md')
-rw-r--r--README.md38
1 files changed, 25 insertions, 13 deletions
diff --git a/README.md b/README.md
index ec9ca08..0ad7f15 100644
--- a/README.md
+++ b/README.md
@@ -8,8 +8,10 @@ For information on how to use Compat, please consult the [manual].
The latest state of development can be found in the [snapshot
version].
-[manual]: https://elpa.gnu.org/packages/doc/compat.html
-[snapshot version]: https://elpa.gnu.org/devel/doc/compat.html
+[manual]:
+ https://elpa.gnu.org/packages/doc/compat.html
+[snapshot version]:
+ https://elpa.gnu.org/devel/doc/compat.html
Contribute
----------
@@ -18,9 +20,12 @@ As compat.el is distribed as part of [GNU ELPA], and therefore
requires a [copyright assignment] to the [FSF], for all non-trivial code
contributions.
-[GNU ELPA]: http://elpa.gnu.org/packages/compat.html
-[copyright assignment]: https://www.gnu.org/software/emacs/manual/html_node/emacs/Copyright-Assignment.html
-[FSF]: https://www.fsf.org/
+[GNU ELPA]:
+ http://elpa.gnu.org/packages/compat.html
+[copyright assignment]:
+ https://www.gnu.org/software/emacs/manual/html_node/emacs/Copyright-Assignment.html
+[FSF]:
+ https://www.fsf.org/
Source code
-----------
@@ -28,8 +33,10 @@ Source code
Compat is developed on [SourceHut]. A restricted [GitHub] mirror is
also provided.
-[SourceHut]: https://sr.ht/~pkal/compat
-[GitHub]: https://github.com/phikal/compat.el
+[SourceHut]:
+ https://sr.ht/~pkal/compat
+[GitHub]:
+ https://github.com/phikal/compat.el
Bug and patches
---------------
@@ -44,11 +51,14 @@ When contributing, make sure to provide test and use the existing
tests defined in compat-test.el. These can be easily executed using
the bundled Makefile:
- make test
+ make test
-[development mailing list]: https://lists.sr.ht/~pkal/compat-devel
-[issue tracker]: https://todo.sr.ht/~pkal/compat
-[email]: mailto:~pkal/compat@todo.sr.ht
+[development mailing list]:
+ https://lists.sr.ht/~pkal/compat-devel
+[issue tracker]:
+ https://todo.sr.ht/~pkal/compat
+[email]:
+ mailto:~pkal/compat@todo.sr.ht
Distribution
------------
@@ -58,5 +68,7 @@ under the [GNU Public License], Version 3 (like Emacs itself). The manual
(`compat.texi`) is distributed under the [GNU Free Documentation
License], Version 1.3.
-[GNU Public License]: https://www.gnu.org/licenses/gpl-3.0.en.html
-[GNU Free Documentation License]: https://www.gnu.org/licenses/fdl-1.3.html
+[GNU Public License]:
+ https://www.gnu.org/licenses/gpl-3.0.en.html
+[GNU Free Documentation License]:
+ https://www.gnu.org/licenses/fdl-1.3.html