Skip to content
zakijssPublic

About

The Onion OS documentation on the Miyoo Mini Plus itself, saved for offline reading.

Topics

Resources

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

A white Miyoo Mini Plus on a wooden stand next to an open book, showing the Onion OS docs in MiniBook

CI Release License: MIT

MiniBook

The Onion OS documentation on the Miyoo Mini Plus itself, readable without Wi-Fi. Part of MiniDeck.

  • Every page you open is saved on the card; Download all for offline saves the rest.
  • Remembers the page you were reading and your place on each page.
  • Y searches page titles, and the text of the saved pages.
  • START opens Settings: start on the page you were reading, or clear the saved pages.

A smoked black Miyoo Mini Plus lying by an open book, showing the Onion OS docs in MiniBook

Install

  • MiniMart: open MiniMart, then Apps > MiniBook. It checks the download and keeps your settings on updates.
  • Zip: download minibook-VERSION.zip from Releases, unzip it onto the root of the SD card, and restart.
  • Every MiniDeck app at once: minideck-all.zip.

Requirements

A Miyoo Mini Plus on Onion OS 4.4, with Wi-Fi. Other devices and firmwares aren't supported.

Building

make check                     # vet, tests, scripts
make package VERSION=1.0.0     # dist/: the release zip, app.json, SHA256SUMS
make deploy HOST=root@miyoo    # build and copy to a device over SSH

Go runs in Docker unless you pass GO=go (Go 1.27). The interface, themes and networking come from the MiniDeck library; see its development notes and contributing guide.

License

MIT. Third-party components are listed in NOTICE. Not made by or affiliated with Miyoo.

About

The Onion OS documentation on the Miyoo Mini Plus itself, saved for offline reading.

Topics

Resources

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages