From b0d7c515cddc7db6928eb9a0f3db0c046190aa24 Mon Sep 17 00:00:00 2001 From: tastytea Date: Fri, 29 Mar 2019 23:08:03 +0100 Subject: [PATCH] Edited README, aesthetically. --- README.md | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index f8cb69f..b05d1af 100644 --- a/README.md +++ b/README.md @@ -4,21 +4,25 @@ boot partition. The checksums and a backup of the contents of `/boot` are stored in `/var/lib/hashboot` by default. If a checksum doesn't match, you have the option to restore the file from backup. -If there is a core- or libreboot bios and flashrom installed, **hashboot** can check bios for modifications too. +If there is a core- or libreboot BIOS and [flashrom](https://flashrom.org/) +installed, **hashboot** can check the BIOS for modifications too. # Install * Make hashboot executable -* Place hashboot anywhere in $PATH +* Place hashboot anywhere in ${PATH} * Install the appropriate init script -* If applicable, copy kernel-hook to /etc/kernel/post{inst,rm}.d/zzz-hashboot (make sure it is called after all other hooks) -* To generate the manpage, install asciidoc and run `build_manpage.sh`. +* If applicable, copy kernel-hook to /etc/kernel/post{inst,rm}.d/zzz-hashboot +(make sure it is called after all other hooks) +* To generate the manpage, install [asciidoc](http://asciidoc.org/) and run +`build_manpage.sh`. # Usage -* First run creates a configuration file. Use bitmask to select desired checkroutines -* Run "hashboot index" to generate checksums and a backup for /boot and MBR -* Run "hashboot check" to check /boot and MBR -* Run "hashboot recover" to replace corrupted files with the backup + +* First run creates a configuration file. Select the desired checkroutines +* Run `hashboot index` to generate checksums and a backup for /boot and MBR +* Run `hashboot check` to check /boot and MBR +* Run `hashboot recover` to replace corrupted files with the backup # Notes @@ -29,6 +33,6 @@ If there is a core- or libreboot bios and flashrom installed, **hashboot** can c ```PLAIN "THE HUG-WARE LICENSE" (Revision 2): teldra and tastytea wrote this. -As Long as you retain this notice you can do whatever you want with this. +As long as you retain this notice you can do whatever you want with this. If we meet some day, and you think this is nice, you can give us a hug. ```