Skip to content

Latest commit

 

History

History
64 lines (52 loc) · 4.85 KB

README.md

File metadata and controls

64 lines (52 loc) · 4.85 KB
Raw

The project is dead

Because of the new kobo colour models using secure boot, which makes us not able to support them with quill and us not having time for a project that will die of the lack of new devices, the project is dead.

Don't expect any support or anything. Until you are a knowledgable person who can with no problem for example... cross compile a qt app you should not touch this project. You are on your own.

Some more info about it:

It was a fun time while it lasted, thanks for the support and love for open source.

and fuck Kobo for the enshittification of their devices

~Szybet

Quill

About Quill

Quill 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.
Quill features:

  • Full integrated KoBox X11 subsystem
  • ePUB, PDF, pictures and plain text display support
  • Versatile configuration options for reading
  • muPDF rendering engine for ePUBs and PDFs
  • Wi-Fi support and web browser (NetSurf)
  • 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
  • 10 built-in fonts
  • Enhanced power management
  • Lock screen/passcode option
  • User-friendly experience

How do I install InkBox?

You can download precompiled OS/binaries here and standard Nickel add-ons (outdated, unmaintained) 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 command-line-reluctant users. Alternatively, you can also open a terminal and check the device node of the Kobo's SD card with fdisk -l. Then dd the image to the SD card like this:

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

IMPORTANT: Quill OS does NOT provide ANY WARRANTY at all and we are not responsible if you brick your device with one of the factory images or update bundles available online. See legal information for more details.

How do I upgrade Quill?

To upgrade Quill, go to http://23.163.0.39/bundles/inkbox/native/update/ and copy the files for your device onto the .inkbox folder in the USB storage partition.

Note: Prior to version 1.6, Quill (then InkBox) had to be upgraded one version at a time. If your device's factory image ships with version 1.5, you need to closely follow the upgrade instructions here.

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

I want to learn more about this!

I suggest you visit the wiki. Feel free to contribute if you think you have something valuable to add.

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 when I have time. You can also join the official Matrix space, Discord server or Linen if you'd like to chat a bit.

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 at my PayPal account, LiberaPay, or via Bitcoin: 3MmXq5o78b4C7ub5sb7F5WVC86jzc6PzSN . I'm a student and motivation has been the only thing that has helped me maintain this project for the last few years. Developing an entire operating system on my own was not an easy task. I have time, but I like to spend it wisely.