smallsolar/postmarketos-mkinitfs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

README: update description and usage sections to match recent changes

Browse Source
This commit is contained in:
Clayton Craft
2023-02-20 21:48:52 -08:00
parent 4ae678d8ce
commit e4fb6cef70
1 changed files with 10 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@@ -1,5 +1,8 @@
`postmarketos-mkinitfs` is a tool for generating an initramfs (and installing `mkinitfs` is a tool for generating an initramfs. It was originally designed
it) on postmarketOS. 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 ## Building
@@ -34,12 +37,12 @@ $ make test
## Usage ## Usage
The application uses configuration from `/etc/deviceinfo`, and does not support The tool can be run with no options:
any other options at runtime. It can be run simply by executing:
``` ```
$ postmarketos-mkinitfs # mkinitfs
``` ```
For historical reasons, a symlink from `mkinitfs` to `postmarketos-mkinitfs` is Configuration is done through a series of flat text files that list directories
also installed by the makefile's `install` target. and files, and by placing scripts in specific directories. See `man 1 mkinitfs`
for more information.