From f7ab3fd3abefc9f1f251c24caa05c1f9763aed5f Mon Sep 17 00:00:00 2001 From: Dill <66445735+them1ghtydill@users.noreply.github.com> Date: Mon, 10 Jan 2022 12:54:18 -0700 Subject: [PATCH 1/4] Update README.md Because I was bored and had nothing to do I went ahead and did some stuff. --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index fd07b9a..c990c5b 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,3 @@ -# 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.
@@ -22,15 +20,18 @@ 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 [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. +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.
-On PC, use [balenaEtcher](https://www.balena.io/etcher/) to flash the InkBox image file to the Kobo's SD card. +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 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 +xzcat inkbox.xz | sudo 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](https://github.com/Kobo-InkBox), then make a [pull request](https://github.com/Kobo-InkBox/inkbox/pulls). I'll be happy to review it. From b30679b3657a83a77e38b52ab9fae85e5c1571aa Mon Sep 17 00:00:00 2001 From: Dill <66445735+them1ghtydill@users.noreply.github.com> Date: Sun, 23 Jan 2022 15:57:45 -0700 Subject: [PATCH 2/4] Update README.md --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index c990c5b..38c6d61 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,10 @@ However, you can also open a terminal and check the device node of the Kobo's SD xzcat inkbox.xz | sudo 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. + 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. From be5bf6173cc5ae77a0f8bd9beac6706c7b6a7dcf Mon Sep 17 00:00:00 2001 From: Nicolas Mailloux <63172576+tux-linux@users.noreply.github.com> Date: Wed, 26 Jan 2022 12:38:21 -0500 Subject: [PATCH 3/4] Update README.md --- README.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 38c6d61..e27932a 100644 --- a/README.md +++ b/README.md @@ -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.
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.
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.

-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. From bf33ee7eba8bed28855b7bd3dc03e1d96d560234 Mon Sep 17 00:00:00 2001 From: Nicolas Mailloux <63172576+tux-linux@users.noreply.github.com> Date: Wed, 26 Jan 2022 13:14:13 -0500 Subject: [PATCH 4/4] Small fix --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e27932a..7b24a32 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,8 @@ 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 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, 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!