Skip to content

Commit

Permalink
README.md: indent bullet items
Browse files Browse the repository at this point in the history
  • Loading branch information
sighook committed May 10, 2024
1 parent 4431478 commit 910867d
Showing 1 changed file with 35 additions and 35 deletions.
70 changes: 35 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,34 +6,34 @@ This directory contains mkinitramfs, a tool used to create a Linux boot image

This distribution is a fork of illiliti's tinyramfs as of commit 8abfcc9 (Fri
May 21 2021) with the following differences:
* bash completion
* GNU-style options/help/usage
* switch to the GNU getopt(1) for command-line parsing
* "local"s to prevent namespace violations
* support "rootdelay" kernel's command-line parameter
* experimental smdev hook
* luks hook: ask for password if header/keyfile is not specified
* manual pages in mdoc(7) format
* new "extrafiles" directive to copy additional files
* "resume" hook to resume machines from hibernation
* bash completion
* GNU-style options/help/usage
* switch to the GNU getopt(1) for command-line parsing
* "local"s to prevent namespace violations
* support "rootdelay" kernel's command-line parameter
* experimental smdev hook
* luks hook: ask for password if header/keyfile is not specified
* manual pages in mdoc(7) format
* new "extrafiles" directive to copy additional files
* "resume" hook to resume machines from hibernation

See git log for complete/further differences.

The original sources can be downloaded from:
1. https://github.com/illiliti/tinyramfs
2. https://github.com/illiliti/tinyramfs/archive/8abfcc9/tinyramfs-8abfcc9.zip
1. https://github.com/illiliti/tinyramfs
2. https://github.com/illiliti/tinyramfs/archive/8abfcc9/tinyramfs-8abfcc9.zip


FEATURES
========

The following advantages can be distinguished:
* no bashisms, only POSIX shell (with "local"s exception)
* portable, no distro specific
* easy to use configuration
* build time and init time hooks
* LUKS (detached header, key, password), LVM
* smdev, mdev, mdevd, eudev, systemd-udevd
* no bashisms, only POSIX shell (with "local"s exception)
* portable, no distro specific
* easy to use configuration
* build time and init time hooks
* LUKS (detached header, key, password), LVM
* smdev, mdev, mdevd, eudev, systemd-udevd


REQUIREMENTS
Expand Down Expand Up @@ -73,24 +73,24 @@ features too:

Build time
----------
* POSIX sh(1p), make(1p) and "mandatory utilities"
* POSIX sh(1p), make(1p) and "mandatory utilities"

Runtime
-------
* POSIX sh(1p) and standard POSIX utilities
* GNU getopt(1), switch_root(8), mount(8), cpio(1)
* POSIX sh(1p) and standard POSIX utilities
* GNU getopt(1), switch_root(8), mount(8), cpio(1)

The following runtime dependencies are optional:

* ldd(1): for copying binary dependencies
* strip(1p): for reducing image size by stripping binaries
* blkid(8): for UUID, LABEL, PARTUUID support
* smdev OR mdev OR mdevd OR eudev OR systemd-udevd or CONFIG_UEVENT_HELPER:
for modular kernel, /dev/mapper/* and /dev/disk/*
* lvm(8): for LVM support
* cryptsetup(8): for LUKS support
* busybox' loadkmap: for keymap support
* kmod OR busybox' modutils+[patch][1]: for non-monolithic kernel
* ldd(1): for copying binary dependencies
* strip(1p): for reducing image size by stripping binaries
* blkid(8): for UUID, LABEL, PARTUUID support
* smdev OR mdev OR mdevd OR eudev OR systemd-udevd or CONFIG_UEVENT_HELPER:
for modular kernel, /dev/mapper/* and /dev/disk/*
* lvm(8): for LVM support
* cryptsetup(8): for LUKS support
* busybox' loadkmap: for keymap support
* kmod OR busybox' modutils+[patch][1]: for non-monolithic kernel

[1]: /patches/modprobe-kernel-version.patch

Expand Down Expand Up @@ -129,13 +129,13 @@ Reboot.
CREDITS
=======

* illiliti <https://github.com/illiliti>
* E5ten <https://github.com/E5ten>
* dylanaraps <https://github.com/dylanaraps>
* illiliti <https://github.com/illiliti>
* E5ten <https://github.com/E5ten>
* dylanaraps <https://github.com/dylanaraps>

You can donate if you like this project to the original author:
* illiliti / (BTC) 1BwrcsgtWZeLVvNeEQSg4A28a3yrGN3FpK
* https://patreon.com/illiliti
* illiliti / (BTC) 1BwrcsgtWZeLVvNeEQSg4A28a3yrGN3FpK
* https://patreon.com/illiliti


LICENSE
Expand Down

0 comments on commit 910867d

Please sign in to comment.