Compare commits

..

1 commit

Author SHA1 Message Date
randogoth
dca2c42a95 docs: add a README 2026-10-14 16:06:11 +03:00

63
README.md Normal file
View file

@ -0,0 +1,63 @@
# The Mews Browser
<img src="app/assets/logo.svg" width="96" alt="The Mews Browser logo">
A local-first reader for Mews pages, Gemini capsules, and Spartan sites, for Android and Linux.
## Screenshots
<table>
<tr>
<td align="center"><a href="app/fastlane/metadata/android/en-US/images/phoneScreenshots/Screenshot_20261014-125758.png" target="_blank"><img src="app/fastlane/metadata/android/en-US/images/phoneScreenshots/Screenshot_20261014-125758.png" width="180"></a><br><sub>Reading a Mews page</sub></td>
<td align="center"><a href="app/fastlane/metadata/android/en-US/images/phoneScreenshots/Screenshot_20261014-125817.png" target="_blank"><img src="app/fastlane/metadata/android/en-US/images/phoneScreenshots/Screenshot_20261014-125817.png" width="180"></a><br><sub>Mews directory</sub></td>
<td align="center"><a href="app/fastlane/metadata/android/en-US/images/phoneScreenshots/Screenshot_20261014-125940.png" target="_blank"><img src="app/fastlane/metadata/android/en-US/images/phoneScreenshots/Screenshot_20261014-125940.png" width="180"></a><br><sub>Gemini capsule</sub></td>
<td align="center"><a href="app/fastlane/metadata/android/en-US/images/phoneScreenshots/Screenshot_20261014-125958.png" target="_blank"><img src="app/fastlane/metadata/android/en-US/images/phoneScreenshots/Screenshot_20261014-125958.png" width="180"></a><br><sub>Settings</sub></td>
</tr>
</table>
## Features
**Reader-controlled presentation** — Every site reads in the typeface, size, and colors you choose, not the author's. Pick from four bundled faces (Atkinson Hyperlegible, Luciole, Literata, Charis SIL), five fixed palettes in light and dark, or a palette derived from each site's address so every site has its own recognizable color.
**Three protocols** — Reads [Mews pages](mews-spec/SPEC.md) over the web, plus `gemini://` and `spartan://`. Gemini certificates are pinned on first visit, and client certificates can be imported and worn per host. Ordinary web pages can be opened in a simplified view or handed to your system browser.
**Local-first** — Pages, bookmarks, subscriptions, and settings live in a local database. The network only revalidates the cache, so anything you've read stays readable offline.
**Subscriptions** — Subscribe to any page with dated links or an Atom feed, Gemini capsules included. New posts from every site land in one list, unread posts survive a restart, and sites are checked in the background at launch.
**Library** — Bookmarks, history, and subscriptions are searchable and taggable.
**Quotations** — Mark text on any page and save it from the selection toolbar. Each quotation keeps the page it came from, its author, and the site's title. Search them by text, author, or page, and share any one with an APA-style citation.
**Navigation**
- Swipe right to go back, left to go forward
- Tap the page to show or hide the address bar
- Keyboard shortcuts on desktop: Ctrl+L for the address, Ctrl+R to reload, Alt+Left and Alt+Right to walk history, Tab to step through links
- Full D-pad support: Left and Right walk the links, center opens one, hold Left or Right to go back or forward, hold center to open the hub
**Languages** — English, German, Spanish, French, Hebrew (right to left), Japanese, Portuguese, and Russian.
## Download
Get the latest .apk on the [Release Page](https://code.randogoth.com/randogoth/the-mews/releases)
## Build
The repository uses [devbox](https://www.jetify.com/devbox) for a reproducible environment with Flutter, the Android SDK, and the Linux desktop toolchain:
```sh
devbox install
devbox run -- bash -c 'cd app && flutter build apk --release'
```
For the Linux desktop bundle (written to `app/build/linux/x64/release/bundle/`):
```sh
devbox run build-linux
```
`devbox run run-linux`, `devbox run test`, and `devbox run analyze` run the desktop app, the tests, and the analyzer.
---
Made with love by randogoth