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

Merge pull request #5 from them1ghtydill/patch-1

Browse source 
Update README.md
This commit is contained in:
tux-linux 2021-11-27 14:17:24 -05:00 committed by GitHub
commit 9d8de723b6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -1,14 +1,14 @@
# inkbox
## What is it?
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) support for a number of devices.
## 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>
It features:
InkBox features:
- Full integrated KoBox X11 subsystem
- ePUB, PDF and plain text support
- Versatile configuration options for reading
- muPDF rendering engine for ePUB (and soon PDFs)
- Wi-Fi support and web browser
- X11 apps seamless integration (KoBox)
- Encrypted storage with EncFS
- Fast dictionary & local storage search
- Dark mode
@ -21,16 +21,17 @@ It features:
- Auto-suspend
- Lock screen/passcode
- User-friendly experience
## How do I install it?
You can download precompiled OS/binaries [here](http://pkgs.kobox.fermino.me/bundles/inkbox/native/) and standard Nickel add-ons are available [there](http://pkgs.kobox.fermino.me/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.
## 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 [there](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>
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:
On PC, use [balenaEtcher](https://www.balena.io/etcher/) to flash the InkBox image file to the Kobo's SD card.
On UNIX-like machines, you can also use balenaEtcher but flashing InkBox OS to your Kobo's SD card is as simple as entering in a terminal session, assuming that `inkbox.xz` is the file you downloaded and that `/dev/mmcblk0` is your SD card's device node (check with `sudo fdisk -l`:
```
xzcat inkbox.xz | dd of=/dev/mmcblk0
```
For Windows users (and command line-reluctant *nix fellows), use [balenaEtcher](https://www.balena.io/etcher/).
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](https://github.com/Kobo-InkBox), then make a [pull request](https://github.com/Kobo-InkBox/inkbox/pulls). I'll be happy to review it.
<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/). 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 here](https://liberapay.com/tux-linux/) or at my [PayPal account](nicomailloux@icloud.com). 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.