]> git.ipfire.org Git - thirdparty/kmod.git/commitdiff
README.md: make it common markdown compatible
authorEmil Velikov <emil.l.velikov@gmail.com>
Sat, 21 Jun 2025 10:09:50 +0000 (11:09 +0100)
committerLucas De Marchi <lucas.de.marchi@gmail.com>
Fri, 27 Jun 2025 20:19:14 +0000 (15:19 -0500)
Adjust the markdown variant, so it renders correctly in both GitHub and
cgit (... vim also seems happier fwiw). AFAICT the latter is using
CommonMarkdown as handled by python-markdown.

Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
Link: https://github.com/kmod-project/kmod/pull/380
Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
README.md

index 567c03299fb728cbc4f5fd1bb6fa15ca31b1a115..5b19af4461e1c0cb2c8dec7fa5cc13a0254e1628 100644 (file)
--- a/README.md
+++ b/README.md
@@ -14,33 +14,35 @@ module-init-tools project.
 
 Links
 =====
-- Mailing list (no subscription needed): linux-modules@vger.kernel.org
-- Mailing list archives: https://lore.kernel.org/linux-modules/
+- Mailing list (no subscription needed): <linux-modules@vger.kernel.org>
+- Mailing list archives: <https://lore.kernel.org/linux-modules/>
 
-- Signed packages: http://www.kernel.org/pub/linux/utils/kernel/kmod/
+- Signed packages: <http://www.kernel.org/pub/linux/utils/kernel/kmod/>
 
 - Git:
-  - Official: https://git.kernel.org/pub/scm/utils/kernel/kmod/kmod.git
-  - Mirror: https://github.com/kmod-project/kmod
-  - Mirror: https://kernel.googlesource.com/pub/scm/utils/kernel/kmod/kmod.git
+    - Official: <https://git.kernel.org/pub/scm/utils/kernel/kmod/kmod.git>
+    - Mirror: <https://github.com/kmod-project/kmod>
+    - Mirror: <https://kernel.googlesource.com/pub/scm/utils/kernel/kmod/kmod.git>
 
 - License:
-  - LGPLv2.1+ for libkmod, testsuite and helper libraries
-  - GPLv2+ for tools/*
+    - LGPLv2.1+ for libkmod, testsuite and helper libraries
+    - GPLv2+ for tools/*
 
 - Irc: `#kmod` on irc.oftc.net
 
-- Issues: https://github.com/kmod-project/kmod/issues
+- Issues: <https://github.com/kmod-project/kmod/issues>
 
 
 Compilation and installation
 ============================
 
 In order to compile the source code you need:
+
 - C11 compiler, supporting a range of GNU extensions - GCC 8+, Clang 6+
 - POSIX.1-2008 C runtime library - Bionic, GNU C library, musl
 
 Optional dependencies, required with the default build configuration:
+
 - ZLIB library
 - LZMA library
 - ZSTD library