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 walnut stand showing the Onion OS docs in MiniBook, on a walnut desk in an old laboratory, with a candlestick, spectacles and a smoked black one lying beside it

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.

From above: a grey Miyoo Mini Plus showing MiniBook's settings and a white one open at the FAQ, on a light wooden desk beside a pair of spectacles

Install

Open MiniMart and pick Apps > MiniBook: it checks the download and keeps your settings on updates. Or unzip minibook-VERSION.zip from Releases onto the root of the SD card and restart. Every MiniDeck app comes in one zip too: minideck-all.zip.

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

Using it

  • X on a page lists its sections and jumps to one. L1/R1 turn a screenful, L2/R2 jump to the top or bottom of a page or a list.
  • Y searches page titles, and the text of the saved pages.
  • START on a page bookmarks it where you are (or removes the bookmark) and lists your bookmarks. They are on Home too.
  • START on Home opens Settings: start on the page you were reading, or clear the saved pages.

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