From 5a92f5b15a7a1cd0736819c6210926e55a317946 Mon Sep 17 00:00:00 2001 From: Nicolas Mailloux Date: Tue, 3 Aug 2021 12:19:42 -0400 Subject: [PATCH] Add features list --- README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c8d8042..fb698d8 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,27 @@ # inkbox ## What is it? -InkBox is an open-source, Qt-based eBook reader for Kobo devices. It currently features, namely, ePUB/plain text support, X11 apps (KoBox) integration and [native open-source OS](https://github.com/Kobo-InkBox/rootfs) support for a number of devices. +InkBox is an open-source, Qt-based eBook reader for Kobo devices. It also comes as an entire [native open-source OS](https://github.com/Kobo-InkBox/rootfs) support for a number of devices. +
+It features: +- ePUB and plain text support +- Versatile configuration options for reading +- muPDF rendering engine for ePUB (and soon PDFs) +- Wi-Fi support and web browser +- X11 apps seamless integration (KoBox) +- Fast dictionary search +- Dark mode +- Strict security policy ensuring that only signed software can be run on the device (this, however, can be adapted to your needs by recompiling the [kernel](https://github.com/Kobo-InkBox/kernel) +- Full factory reset option if needed +- Seamless update process +- VNC viewer app +- Search function +- 9 built-in fonts +- Auto-suspend +- Lock screen/passcode +- User-friendly experience ## How do I install it? -You can download precompiled OS/binaries [here](http://pkgs.kobox.fermino.me/bundles/inkbox/native/) and standard Nickel add-ons are available [there](http://pkgs.kobox.fermino.me/bundles/inkbox/nickel/), although support for them has been stopped until further notice. +You can download precompiled OS/binaries [here](http://pkgs.kobox.fermino.me/bundles/inkbox/native/) and standard Nickel add-ons are available [there](http://pkgs.kobox.fermino.me/bundles/inkbox/nickel/), although support for them has been stopped until further notice. Huge thanks to [@fermino](https://github.com/fermino) for providing free hosting.
Flashing InkBox OS to your Kobo's SD card is as simple as doing, on most *nix machines, assuming that `inkbox.xz` is the file you downloaded and that `/dev/mmcblk0` is your SD card's device node: ```