diff --git a/README.md b/README.md index e31a856..8c92487 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -unl0kr +Unl0kr ====== Framebuffer-based disk unlocker for the initramfs based on [LVGL]. @@ -7,7 +7,7 @@ Framebuffer-based disk unlocker for the initramfs based on [LVGL]. # About -unl0kr is an [osk-sdl] clone written in [LVGL] and rendering directly to the Linux framebuffer. As a result, it doesn't depend on GPU hardware acceleration. +Unl0kr is an [osk-sdl] clone written in [LVGL] and rendering directly to the Linux framebuffer. As a result, it doesn't depend on GPU hardware acceleration. For some background on how unl0kr came to be, see postmarketOS/osk-sdl#121. @@ -74,7 +74,7 @@ $ sudo ./unl0kr ## Fonts -In order to work with [LVGL], fonts need to be converted to bitmaps, stored as C arrays. unl0kr currently uses a combination of the [Montserrat] font for text and the [FontAwesome] font for pictograms. For both fonts only limited character ranges are included to reduce the binary size. To (re)generate the C file containing the combined font, run the following command +In order to work with [LVGL], fonts need to be converted to bitmaps, stored as C arrays. Unl0kr currently uses a combination of the [Montserrat] font for text and the [FontAwesome] font for pictograms. For both fonts only limited character ranges are included to reduce the binary size. To (re)generate the C file containing the combined font, run the following command ``` $ npx lv_font_conv --bpp 4 --size 32 --no-compress -o montserrat_extended_32.c --format lvgl \ @@ -105,7 +105,7 @@ Below is a short explanation of the different unicode ranges used above. ## Keyboard layouts -unl0kr uses [squeekboard layouts] converted to C via [squeek2lvgl]. To regenerate the layouts, run +Unl0kr uses [squeekboard layouts] converted to C via [squeek2lvgl]. To regenerate the layouts, run ``` $ ./regenerate-layouts.sh @@ -129,7 +129,7 @@ The mouse cursor image was taken from [lv_sim_emscripten]. # License -unl0kr is licensed under the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. +Unl0kr is licensed under the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. The [Montserrat] font is licensed under the Open Font License.