commit 22e8f76dc5e667a4ae4bcfd4cfcdab3db3d18d45
parent dee31183e886558f7bfcec05ddfd70ee49096940
Author: Pollux <pollux@pollux.codes>
Date: Sat, 7 Mar 2026 15:16:51 +0000
style: Make README markdown
Signed-off-by: Pollux <pollux@pollux.codes>
Diffstat:
| D | README | | | 36 | ------------------------------------ |
| A | README.md | | | 35 | +++++++++++++++++++++++++++++++++++ |
2 files changed, 35 insertions(+), 36 deletions(-)
diff --git a/README b/README
@@ -1,36 +0,0 @@
-splashdown - minimal bootsplash program
-=======================================
-
-splashdown is a minimal, daemon-less bootsplash program. When called, it draws
-a user-specified image to the framebuffer and renders text from the command
-line on top of it.
-
-Requirements
-------------
-To build, splashdown depends on freetype2 and libjpeg-turbo.
-
-librc is also required if using the included openrc plugin
-
-Installation
-------------
-Copy config.def.h to config.h, then edit it and config.mk to your liking. To
-build and install splashdown, use make and copy the resulting executable to your
-path.
-
-From this point, the exact means of using splashdown during bootup and shutdown
-varies significantly between systems. It is recommended to use a custom
-initramfs and call splashdown after each phase of the boot process.
-
-It is also recommended to use chvt to switch to a dedicated tty for splashdown,
-and to pass console=tty<n> to the kernel to put boot messages on a separate tty
-(so they don't overwrite splashdown).
-
-If using openrc, the openrc plugin can be used to preserve splashdown through
-the openrc service initialization process and to also show it during shutdown.
-To install the plugin, run "make plugin" and copy the resulting shared object
-file to the openrc plugin directory.
-
-Acknowledgements
-----------------
-- The suckless software organization for their philosophy.
-- Amadeusz Żołnowski and Matt Jolly for showing how to make an openrc plugin.
diff --git a/README.md b/README.md
@@ -0,0 +1,35 @@
+# splashdown - minimal bootsplash program
+
+splashdown is a minimal, daemon-less bootsplash program. When called, it draws
+a user-specified image to the framebuffer and renders text from the command
+line on top of it.
+
+## Requirements
+
+To build, splashdown depends on freetype2 and libjpeg-turbo.
+
+librc is also required if using the included openrc plugin
+
+## Installation
+
+Copy config.def.h to config.h, then edit it and config.mk to your liking. To
+build and install splashdown, use make and copy the resulting executable to your
+path.
+
+From this point, the exact means of using splashdown during bootup and shutdown
+varies significantly between systems. It is recommended to use a custom
+initramfs and call splashdown after each phase of the boot process.
+
+It is also recommended to use chvt to switch to a dedicated tty for splashdown,
+and to pass console=tty<n> to the kernel to put boot messages on a separate tty
+(so they don't overwrite splashdown).
+
+If using openrc, the openrc plugin can be used to preserve splashdown through
+the openrc service initialization process and to also show it during shutdown.
+To install the plugin, run "make plugin" and copy the resulting shared object
+file to the openrc plugin directory.
+
+## Acknowledgements
+
+- The suckless software organization for their philosophy.
+- Amadeusz Żołnowski and Matt Jolly for showing how to make an openrc plugin.