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

Update README.md

Browse source
This commit is contained in:
Nicolas Mailloux 2022-01-26 12:38:21 -05:00 committed by GitHub
parent b30679b365
commit be5bf6173c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -1,9 +1,10 @@
# 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](https://github.com/Kobo-InkBox/rootfs) and provides support for a number of devices.
<br>
InkBox features:
- Full integrated KoBox X11 subsystem
- ePUB, PDF and plain text support
- ePUB, PDF, pictures and plain text display support
- Versatile configuration options for reading
- muPDF rendering engine for ePUB (and soon PDFs)
- Wi-Fi support and web browser
@ -20,24 +21,26 @@ InkBox features:
- Lock screen/passcode
- User-friendly experience
## How do I install InkBox?
You can download precompiled OS/binaries [here](http://23.163.0.39/bundles/inkbox/native/) and standard Nickel add-ons are available [here](http://23.163.0.39/bundles/inkbox/nickel/), although support for them has been stopped until further notice. Huge thanks to [@fermino](https://github.com/fermino) for providing free hosting.
You can download precompiled OS/binaries [here](http://23.163.0.39/bundles/inkbox/native/) and standard Nickel add-ons (outdated, unmaintained) are available [here](http://23.163.0.39/bundles/inkbox/nickel/), although support for them has been stopped until further notice. Huge thanks to [@fermino](https://github.com/fermino) for providing free hosting.
<br>
On Windows, use [balenaEtcher](https://www.balena.io/etcher/) to flash the InkBox image file to the Kobo's SD card.
On Linux and MacOS, [balenaEtcher](https://www.balena.io/etcher/) 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:
On Linux and MacOS, [balenaEtcher](https://www.balena.io/etcher/) 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 | sudo dd of=/dev/mmcblk0
xzcat inkbox.xz | 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.
To upgrade InkBox, go to http://23.163.0.39/bundles/inkbox/native/update/ and extract 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).
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](http://inkbox.ddns.net:40/wiki). The [General information](http://inkbox.ddns.net:40/wiki/index.php?title=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](https://github.com/Kobo-InkBox), then make a [pull request](https://github.com/Kobo-InkBox/inkbox/pulls). I'll be happy to review it.
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.
<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 here](https://liberapay.com/tux-linux/) or at my [PayPal account](https://paypal.me/NicolasMailloux/). 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.
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/NicolasMailloux/) or on [LiberaPay](https://liberapay.com/tux-linux/). 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.