Compare commits

...

6 commits

Author SHA1 Message Date
Ansraer
9c526573ea
Merge 201b13a20a into cc2af329d0 2024-08-14 22:18:54 +01:00
Szybet
cc2af329d0
Merge pull request #83 from chloe-everhart/patch-1
Update README.md
2024-07-05 10:00:11 +02:00
chloe-everhart
a3ec711fb0
Update README.md
Updated the non-linked references to "InkBox" to say "Quill" instead.
2024-07-03 07:35:41 -08:00
Szybet
d416ecdd58
Merge pull request #77 from michaelachrisco/master
Fix Inkbox references to Quill
2024-05-27 21:19:09 +02:00
Michael Chrisco
326ed49a39
fix(readme): Fix Inkbox references to Quill 2024-05-27 12:13:18 -07:00
Szybet
58993104cc
Update README.md 2024-04-02 22:46:18 +02:00

View file

@ -1,9 +1,9 @@
# InkBox # Quill
<img src="https://github.com/Kobo-InkBox/inkbox/blob/master/screenshots/homepage.png?raw=true" width="30%"></img> <img src="https://github.com/Kobo-InkBox/inkbox/blob/master/screenshots/reading.png?raw=true" width="30%"></img> <img src="https://github.com/Kobo-InkBox/inkbox/blob/master/screenshots/library.png?raw=true" width="30%"></img> <img src="https://github.com/Quill-OS/quill/blob/master/screenshots/homepage.png?raw=true" width="30%"></img> <img src="https://github.com/Quill-OS/quill/blob/master/screenshots/reading.png?raw=true" width="30%"></img> <img src="https://github.com/Quill-OS/quill/blob/master/screenshots/library.png?raw=true" width="30%"></img>
## About InkBox ## About Quill
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) and provides support for a number of devices. Quill is an open-source, Qt-based eBook reader for Kobo devices. It also comes as an entire [native open-source OS](https://github.com/Quill-OS/rootfs) and provides support for a number of devices.
<br> <br>
InkBox features: Quill features:
- Full integrated KoBox X11 subsystem - Full integrated KoBox X11 subsystem
- ePUB, PDF, pictures and plain text display support - ePUB, PDF, pictures and plain text display support
- Versatile configuration options for reading - Versatile configuration options for reading
@ -12,7 +12,7 @@ InkBox features:
- Encrypted storage with EncFS - Encrypted storage with EncFS
- Fast dictionary & local storage search - Fast dictionary & local storage search
- Dark mode - 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)) - 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/Quill-OS/kernel))
- Full factory reset option if needed - Full factory reset option if needed
- Seamless update process - Seamless update process
- VNC viewer app - VNC viewer app
@ -33,18 +33,18 @@ Alternatively, you can also open a terminal and check the device node of the Kob
``` ```
xzcat inkbox.xz | dd of=/dev/mmcblk0 xzcat inkbox.xz | dd of=/dev/mmcblk0
``` ```
<b>IMPORTANT:</b> 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](https://github.com/Kobo-InkBox/inkbox/blob/master/LEGAL.md) for more details. <b>IMPORTANT:</b> 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](https://github.com/Quill-OS/quill/blob/master/LEGAL.md) for more details.
## How do I upgrade InkBox? ## How do I upgrade Quill?
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. 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, 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](http://23.163.0.39/bundles/inkbox/native/update/1.6/HOWTO-Update). **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](http://23.163.0.39/bundles/inkbox/native/update/1.6/HOWTO-Update).
If you install the Nickel add-on, unpack the 'base' archive in the root of the onboard storage, not in any subfolder inside it. 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 want to learn more about this!
I suggest you visit the [wiki](https://github.com/Kobo-InkBox/inkbox/wiki). Feel free to contribute if you think you have something valuable to add. I suggest you visit the [wiki](https://github.com/Quill-OS/quill/wiki). Feel free to contribute if you think you have something valuable to add.
## How can I contribute? ## 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](https://github.com/Kobo-InkBox), then make a [pull request](https://github.com/Kobo-InkBox/inkbox/pulls). I'll be happy to review it when I have time. You can also join the official [Matrix space](https://matrix.to/#/#inkbox-os-project:matrix.org) or [Discord server](https://discord.com/invite/uSWtWbY23m) if you'd like to chat a bit. 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](https://github.com/Quill-OS), then make a [pull request](https://github.com/Quill-OS/quill/pulls). I'll be happy to review it when I have time. You can also join the official [Matrix space](https://matrix.to/#/#inkbox-os-project:matrix.org), [Discord server](https://discord.com/invite/uSWtWbY23m) or [Linen](https://www.linen.dev/s/quill-os) if you'd like to chat a bit.
<br><br> <br><br>
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](https://paypal.me/inkboxos/), [LiberaPay](https://liberapay.com/tux-linux/), 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. 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](https://paypal.me/inkboxos/), [LiberaPay](https://liberapay.com/tux-linux/), 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.