From e4fb6cef70d85e9e8548956749ed04d8dae6d43d Mon Sep 17 00:00:00 2001 From: Clayton Craft Date: Mon, 20 Feb 2023 21:48:52 -0800 Subject: [PATCH] README: update description and usage sections to match recent changes --- README.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index e16ff60..89f4d52 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ -`postmarketos-mkinitfs` is a tool for generating an initramfs (and installing -it) on postmarketOS. +`mkinitfs` is a tool for generating an initramfs. It was originally designed +for postmarketOS, but a long term design goal is to be as distro-agnostic as +possible. It's capable of generating a split initramfs, in the style used by +postmarketOS, and supports running `boot-deploy` to install/finalize boot files +on a device. ## Building @@ -34,12 +37,12 @@ $ make test ## Usage -The application uses configuration from `/etc/deviceinfo`, and does not support -any other options at runtime. It can be run simply by executing: +The tool can be run with no options: ``` -$ postmarketos-mkinitfs +# mkinitfs ``` -For historical reasons, a symlink from `mkinitfs` to `postmarketos-mkinitfs` is -also installed by the makefile's `install` target. +Configuration is done through a series of flat text files that list directories +and files, and by placing scripts in specific directories. See `man 1 mkinitfs` +for more information.