Merge pull request #237 from 1vybridge/main

docs/*: Replace ugrd/UGRD with correct spelling

docs/benchmarks.md

@@ -1,8 +1,8 @@
-## How does UGRD compare to other generators?
+## How does µgRD compare to other generators?
 
 ### Run time
 
-People say python is slow, but UGRD is very fast, even on slow hardware.
+People say python is slow, but µgRD is very fast, even on slow hardware.
 
 #### Raspberry pi 3
 
@@ -26,7 +26,7 @@ sys     0m2.147s
 
 ##### Compression
 
-ugrd compression is limited by single thread python performance, but still builds faster than dracut which calls zstd:
+µgRD compression is limited by single thread python performance, but still builds faster than dracut which calls zstd:
 
 ```
 time dracut --force
@@ -86,7 +86,7 @@ sys     0m0.643s
 
 ### Image size
 
-ugrd makes very small images, even with no compression, it creates smaller images than dracut with zstd compression!
+µgRD makes very small images, even with no compression, it creates smaller images than dracut with zstd compression!
 
 #### Raspberry pi 3
 
@@ -115,7 +115,7 @@ ugrd makes very small images, even with no compression, it creates smaller image
 
 ### Boot time
 
-ugrd boots faster than dracut, even without udev:
+µgRD boots faster than dracut, even without udev:
 
 Dracut boot:
 ```
@@ -154,7 +154,7 @@ Dracut boot:
 [    5.900654] dracut: Switching root
 ```
 
-ugrd boot:
+µgRD boot:
 ```
 [    3.106379] Freeing unused kernel memory: 4864K
 [    3.108254] Run /init as init process
@@ -190,4 +190,4 @@ ugrd boot:
 ```
 
 > Multiple tests were performed, boot timed did not deviate by more than half a second
-> Tests where undervoltages were reported were ignored, but none were detected in ugrd runs
+> Tests where undervoltages were reported were ignored, but none were detected in µgRD runs

docs/bootloader_config.md

@@ -8,7 +8,7 @@ If the kernel is built with the `CONFIG_EFI_STUB` option, the path of the initra
 
 This can be set with:
 
-`efibootmgr -c -d /dev/sda -L "Gentoo UGRD" -l 'vmlinuz-gentoo.efi' -u 'initrd=ugrd.cpio'`
+`efibootmgr -c -d /dev/sda -L "Gentoo ugRD" -l 'vmlinuz-gentoo.efi' -u 'initrd=ugrd.cpio'`
 
 > This example assumes that the ESP is the first partition on `/dev/sda`, the kernel is named `vmlinuz-gentoo.efi` under the root of the ESP, and `ugrd.cpio` is also on the ESP root.
 

docs/configuration.md

@@ -1,6 +1,6 @@
 # Configuration
 
-At runtime, ugrd will try to read `/etc/ugrd/config.toml` for configuration options unless another file is specified.
+At runtime, µgRD will try to read `/etc/ugrd/config.toml` for configuration options unless another file is specified.
 
 There is very little to configure in the base image, unless you are just interested in specifying a few required kmods/files to be pulled into the initramfs.
 

docs/dev_manual.md

@@ -14,7 +14,7 @@ Within modules, all config values are imported, then processed according to the
 
 ## Imports
 
-UGRD allows python functions to be imported from modules using the `imports` dict.
+µgRD allows python functions to be imported from modules using the `imports` dict.
 
 `imports` entries have a key which is the name of the hook to import into, and a value which is a dict of module names and lists of functions to import.
 

docs/runtime_usage.md

@@ -2,9 +2,9 @@
 
 `ugrd` runs the `init` script generated in the build dir. In cases where `agetty` is needed, all but basic initialization and the final switch_root are performed in `init_main.sh`.
 
-UGRD should prompt for relevant input or warn if devices are missing at runtime.
+µgRD should prompt for relevant input or warn if devices are missing at runtime.
 
-> If UGRD does not print its version after the kernel calls /init, the `ugrd.base.console` module may need to be enabled to start an agetty session.
+> If µgRD does not print its version after the kernel calls /init, the `ugrd.base.console` module may need to be enabled to start an agetty session.
 
 ### Failure recovery