michael/quill
1
0
Fork 0
mirror of https://github.com/Quill-OS/quill.git synced 2024-12-26 23:57:22 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions
An open-source, Qt-based eBook reader for Kobos (and other devices).
156 commits 7 branches 10 tags 54 MiB
C++ 99%
QMake 1%
Find a file
Nicolas Mailloux ea44e2a762 Update README (again)
2021-08-03 11:49:16 -04:00
resources Toast messages; Wi-Fi dialog improvements 2021-07-14 01:24:30 -04:00
alert.cpp Kobo Glo UI/brightness/DPI support 2021-06-26 10:09:51 -04:00
alert.h Kobo Glo UI/brightness/DPI support 2021-06-26 10:09:51 -04:00
alert.ui UI fixes 2021-04-06 21:29:33 -04:00
apps.cpp Add non-root clause for VNC viewer 2021-07-09 15:12:53 -04:00
apps.h VNC viewer support 2021-07-06 00:13:11 -04:00
apps.ui Virtual keyboard! 2021-07-05 16:01:32 -04:00
AUTHORS Update AUTHORS 2021-06-30 19:19:33 -04:00
brightnessdialog.cpp Brightness dialog: set lighting warmth option 2021-07-16 16:41:36 -04:00
brightnessdialog.h Brightness dialog: set lighting warmth option 2021-07-16 16:41:36 -04:00
brightnessdialog.ui Brightness dialog: set lighting warmth option 2021-07-16 16:41:36 -04:00
calendarapp.cpp InkBox v1.0 Release Commit 2021-03-25 08:00:19 -04:00
calendarapp.h InkBox v1.0 Release Commit 2021-03-25 08:00:19 -04:00
calendarapp.ui InkBox v1.0 Release Commit 2021-03-25 08:00:19 -04:00
def.h InkBox v1.0 Release Commit 2021-03-25 08:00:19 -04:00
dictionarywidget.cpp The search button now does something 2021-07-05 22:21:20 -04:00
dictionarywidget.h The search button now does something 2021-07-05 22:21:20 -04:00
dictionarywidget.ui Set definition QTextEdit to NoTextInteractionFlags 2021-07-06 20:12:10 -04:00
eink.qrc Wi-Fi button/icon in MainWindow 2021-07-13 15:18:59 -04:00
functions.h Some fixes for Wi-Fi dialog; IP address in System Info 2021-07-20 23:27:32 -04:00
generaldialog.cpp Some fixes for Wi-Fi dialog; IP address in System Info 2021-07-20 23:27:32 -04:00
generaldialog.h Wi-Fi connection dialog implemented and working 2021-07-14 18:23:54 -04:00
generaldialog.ui The search button now does something 2021-07-05 22:21:20 -04:00
inkbox.pro Some fixes for Wi-Fi dialog; IP address in System Info 2021-07-20 23:27:32 -04:00
koboxappsdialog.cpp Virtual keyboard sizeup for Libra 2021-07-11 23:48:11 -04:00
koboxappsdialog.h KoBox splash screen 2021-04-30 23:55:38 -04:00
koboxappsdialog.ui KoBox Apps dialog can scan through the extensions list 2021-04-30 12:49:33 -04:00
koboxsettings.cpp Kobo Libra compatibility; new font: Bitter 2021-07-11 01:08:38 -04:00
koboxsettings.h Implemented "Wipe KoBox user data" function 2021-06-14 14:31:49 -04:00
koboxsettings.ui Kobo Libra compatibility; new font: Bitter 2021-07-11 01:08:38 -04:00
LICENSE Initial commit 2021-03-25 07:48:20 -04:00
main.cpp Brightness dialog: set lighting warmth option 2021-07-16 16:41:36 -04:00
mainwindow.cpp Comment testing things again 2021-07-21 13:55:46 -04:00
mainwindow.h Some fixes for Wi-Fi dialog; IP address in System Info 2021-07-20 23:27:32 -04:00
mainwindow.ui Wi-Fi connection dialog implemented and working 2021-07-14 18:23:54 -04:00
otamanager.cpp Some fixes for Wi-Fi dialog; IP address in System Info 2021-07-20 23:27:32 -04:00
otamanager.h Some fixes for Wi-Fi dialog; IP address in System Info 2021-07-20 23:27:32 -04:00
otamanager.ui Fix build issue with otaManager 2021-07-23 17:32:30 -04:00
quit.cpp Wi-Fi dialog draft 2021-07-13 12:27:38 -04:00
quit.h Vacuum-cleaner; centralized all functions in one header file. I'm sorry. 2021-04-05 09:50:58 -04:00
quit.ui InkBox v1.0 Release Commit 2021-03-25 08:00:19 -04:00
reader.cpp Toast messages; Wi-Fi dialog improvements 2021-07-14 01:24:30 -04:00
reader.h Toast messages; Wi-Fi dialog improvements 2021-07-14 01:24:30 -04:00
reader.ui More fixes; new fonts 2021-07-11 22:11:13 -04:00
README.md Update README (again) 2021-08-03 11:49:16 -04:00
resources.qrc InkBox v1.0 Release Commit 2021-03-25 08:00:19 -04:00
savedwords.cpp Finalized low/critical battery alert warnings 2021-04-23 08:47:05 -04:00
savedwords.h KoBox launcher basic implementation 2021-04-29 23:36:25 -04:00
savedwords.ui InkBox v1.0 Release Commit 2021-03-25 08:00:19 -04:00
settings.cpp Kobo Libra compatibility; new font: Bitter 2021-07-11 01:08:38 -04:00
settings.h USBMS splash: bring down brightness 2021-06-29 15:28:54 -04:00
settings.ui Auto-suspend feature implemented :check: 2021-06-28 19:57:40 -04:00
settingschooser.cpp More Glo-related new things 2021-06-26 19:29:51 -04:00
settingschooser.h Added KoBox settings base 2021-04-27 08:40:08 -04:00
settingschooser.ui Finalized working tab switcher 2021-04-24 12:44:57 -04:00
textwidget.cpp Done with system info dialog 2021-06-14 12:24:20 -04:00
textwidget.h Add QTextBrowser widget and dialog 2021-06-08 07:49:52 -04:00
textwidget.ui Correct layout 2021-06-20 17:32:25 -04:00
toast.cpp Wi-Fi connection dialog implemented and working 2021-07-14 18:23:54 -04:00
toast.h Wi-Fi connection dialog implemented and working 2021-07-14 18:23:54 -04:00
toast.ui Toast messages; Wi-Fi dialog improvements 2021-07-14 01:24:30 -04:00
usbms_splash.cpp Let others know that we're in USB MS 2021-06-29 16:32:31 -04:00
usbms_splash.h USBMS splash: bring down brightness 2021-06-29 15:28:54 -04:00
usbms_splash.ui InkBox v1.0 Release Commit 2021-03-25 08:00:19 -04:00
virtualkeyboard.cpp Virtual keyboard sizeup for Libra 2021-07-11 23:48:11 -04:00
virtualkeyboard.h VNC viewer support 2021-07-06 00:13:11 -04:00
virtualkeyboard.ui Virtual keyboard! 2021-07-05 16:01:32 -04:00
virtualkeypad.cpp Implemented "Go to page" dialog and function. 2021-07-05 13:45:35 -04:00
virtualkeypad.h Virtual keyboard! 2021-07-05 16:01:32 -04:00
virtualkeypad.ui Implemented "Go to page" dialog and function. 2021-07-05 13:45:35 -04:00
wifidialog.cpp Wi-Fi connection dialog implemented and working 2021-07-14 18:23:54 -04:00
wifidialog.h Wi-Fi connection dialog implemented and working 2021-07-14 18:23:54 -04:00
wifidialog.ui Toast messages; Wi-Fi dialog improvements 2021-07-14 01:24:30 -04:00

README.md

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 support for a number of devices.

How do I install it?

You can download precompiled OS/binaries here and standard Nickel add-ons are available there, although support for them has been stopped until further notice.
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:

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

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. 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.