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.