quill/README.md
2022-01-23 15:57:45 -07:00

2.8 KiB

About InkBox

InkBox is an open-source, Qt-based eBook reader for Kobo devices. It also comes as an entire native open-source OS and provides support for a number of devices.
InkBox features:

  • Full integrated KoBox X11 subsystem
  • ePUB, PDF and plain text support
  • Versatile configuration options for reading
  • muPDF rendering engine for ePUB (and soon PDFs)
  • Wi-Fi support and web browser
  • Encrypted storage with EncFS
  • Fast dictionary & local storage 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)
  • 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 InkBox?

You can download precompiled OS/binaries here and standard Nickel add-ons are available here, although support for them has been stopped until further notice. Huge thanks to @fermino for providing free hosting.

On Windows, use balenaEtcher to flash the InkBox image file to the Kobo's SD card.

On Linux and MacOS, balenaEtcher is the easiest option for the terminal-shy people out there. However, you can also open a terminal and check the device node of the Kobo's SD card with sudo fdisk -l. Then dd the image to the SD card like this:

xzcat inkbox.xz | sudo dd of=/dev/mmcblk0

How do I upgrade InkBox?

To upgrade InkBox, go to http://23.163.0.39/bundles/inkbox/native/update/ and extract the files for your model onto the .inkbox folder on your device. Note: InkBox has to be upgraded one version at a time.

If you install the Nickel add-on, unpack the 'base' archive in the root of the onboard storage, not in any subfolder inside it.

How can I contribute?

If you like this project and want to improve it in some way, feel free to fork this repository or one of the subprojects this organization hosts, then make a pull request. I'll be happy to review it.

On the other hand, if you don't have the appropriate coding skills or just want to help in some way, feel free to make a donation here or at my PayPal account. I'm a student and motivation has been the only thing that has helped me maintain this project for the last months. Developing an entire operating system on my own was not an easy task. I have time, but I like to spend it wisely.