readme.club, on your e-reader.
翻译准备中
取自仓库 README
正在加载完整 README。 以下为已保存的摘录。
Your e-ink reader just got its own club. readme.club is the first e-ink media with its own app for e-readers. News, guides, wallpapers, games and quizzes — right on the device, offline, in glorious black and white. On any Android 11+ device: e-readers first, phones too. readme.club 2.0 on an Xteink S4 (4.3", 480 × 800): Home, Wallpapers, The Stacks, Learn and Member. Made for e-ink, not squeezed onto it • Pages, never scrolling. Everything is cut to the sc [README 설치·사용 부분 발췌] Install in three steps查看完整 README ↗
readme.club is the first e-ink media with its own app for e-readers. News, guides, wallpapers, games and quizzes — right on the device, offline, in glorious black and white. On any Android 11+ device: e-readers first, phones too.
readme.club 2.0 on an Xteink S4 (4.3", 480 × 800): Home, Wallpapers, The Stacks, Learn and Member.
| Home | The story you were reading, then one tile per section saying what is inside. |
| News | readme.club articles with their photos, saved for offline reading, each with its reading time and a New pill until read. You pick up exactly where you stopped. Want it on your phone? Scan the QR code from the reader menu. |
| Guides | A real bookshelf: pick a brand, pick a guide, jump to any step from its contents — even with Wi-Fi off. |
| Wallpapers | 4,000+ community wallpapers, filtered to fit your screen exactly, with search and sort. One tap and the original lands in Pictures/ReadmeClub. |
| Games | The Stacks, an endless and absurd text dungeon under a bookshop; Sudoku (6 × 6 or 9 × 9); Mines; Lights out. Made for e-ink: every move is one redraw. |
| Learn | 200 general-knowledge questions in the app, quiz packs from readme.club, and flashcards of the questions you missed. |
| Member | Optional: link your readme.club account with your member number and an emailed code, and your favourite and uploaded wallpapers and your member card come to the reader. |
| Settings | Text size, Sans or Serif, refresh rhythm, storage per section — and one-tap updates. |
Built and loved on the Xteink S4 (Android 11, 4.3", 480 × 800), and made for any Android 11+ device — e-readers first, phones too: the layout grows with the screen, the wallpaper gallery matches your display through readme.club's device registry, volume and page-turn buttons both turn pages, and forced refreshes can be switched off on readers with their own refresh modes. Device notes: docs/DEVICE.md.
| Device | Android | Status |
|---|---|---|
| Xteink S4 | 11 | Reference device |
| Mudita Kompakt | 12 | Works |
| Supernote Nomad A6X2 | 11 (Chauvet 3) | Works |
| Supernote Manta A5X2 | 11 (Chauvet 3) | Works |
| Boox Note Air5 C | 15 | Works |
Running it on another reader? Send a device report — a short form on readme.club, no account needed, and your reader joins the list. On GitHub? The device report issue form works too.
Got a computer handy? adb install -r readmeclub.apk works too.
./gradlew testDebugUnitTest assembleDebug
adb install -r app/build/outputs/apk/debug/app-debug.apk
What changed in each version: CHANGELOG.md.
Debug builds install next to the official app as readme.club dev. Every push is built by
GitHub Actions; a v* tag publishes a signed release (docs/RELEASE.md).
Ideas, bug reports and pull requests are all welcome — this app grows with the community, just like the site. The house rules live in CLAUDE.md: no dependency without a reason, no animation, no scrolling, no link leaving the app, everything in English.
Not on the club yet? Grab a free member account at readme.club/member/join
GPL-3.0, with additional terms in NOTICE: any distributed version must keep the attribution “Based on readme.club for Android by Florent Bertiaux”, and the readme.club name, logo and icon are not licensed for use by modified versions.