michael/quill
1
0
Fork 0
mirror of https://github.com/Quill-OS/quill.git synced 2024-10-31 21:33:22 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions
An open-source, Qt-based eBook reader for Kobos (and other devices).
503 commits 7 branches 10 tags 54 MiB
C++ 99%
QMake 1%
Find a file
Nicolas Mailloux 6a4f8835d4 Add small log
2023-05-21 17:26:39 +00:00
src Add small log 2023-05-21 17:26:39 +00:00
.gitignore Initial power daemon integration (credit: @Szybet) 2022-07-26 00:29:13 -04:00
AUTHORS AUTHORS: Add credit for Remix Icon 2022-10-12 23:27:44 -04:00
inkbox.pro wifiLogger: Small design tweak 2022-10-11 22:31:11 -04:00
LEGAL.md Add legal information 2022-04-20 20:53:51 -04:00
LICENSE Initial commit 2021-03-25 07:48:20 -04:00
README.md Small README.md change 2023-02-28 15:02:45 -05:00

README.md

InkBox

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, 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: InkBox 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 InkBox?

To upgrade InkBox, 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, 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. The General information page is a pretty good place to start. 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 or Discord server 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 or on LiberaPay. 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.