From c6c8ea82001cd38a93dc9439a46dfca74a91f3c3 Mon Sep 17 00:00:00 2001 From: gnacho Date: Tue, 27 Oct 2026 12:46:53 +0100 Subject: [PATCH] docs: add Flathub install instructions to both READMEs Scribe is published on Flathub as io.github.gnacho.Scribe, so the badges, the intro and a dedicated section now point there first. Also corrects the Flatpak section: only cargo-sources.json is a symlink, not the manifest. Refs #158 --- README.es.md | 35 +++++++++++++++++++++++++++++------ README.md | 36 ++++++++++++++++++++++++++++++------ 2 files changed, 59 insertions(+), 12 deletions(-) diff --git a/README.es.md b/README.es.md index 520d3c5..db647f6 100644 --- a/README.es.md +++ b/README.es.md @@ -6,6 +6,7 @@

+ Flathub Release License: AGPL-3.0-or-later

@@ -26,7 +27,13 @@ usar un motor de navegador. Míralo en acción en [scribe.cloudless.club](https://scribe.cloudless.club): todas las funciones explicadas y funcionando, capturas en claro y oscuro, una demo de -escritura y la instalación para .deb, .rpm, AppImage y AUR. +escritura y la instalación para Flathub, .deb, .rpm, AppImage y AUR. + +Disponible en Flathub: + +```sh +flatpak install flathub io.github.gnacho.Scribe +``` ## Por qué existe esto @@ -252,7 +259,21 @@ Fedora: sudo dnf install gtk4-devel libadwaita-devel gtksourceview5-devel enchant2-devel glib2-devel ``` -## Instalar +## Instalar desde Flathub + +Flathub es la forma más sencilla de instalar Scribe, y se actualiza junto con el +resto del sistema: + +```sh +flatpak install flathub io.github.gnacho.Scribe +flatpak run io.github.gnacho.Scribe +``` + +La ficha está en [flathub.org/apps/io.github.gnacho.Scribe](https://flathub.org/apps/io.github.gnacho.Scribe). +Hay builds para x86_64 y aarch64. Los paquetes `.deb`, `.rpm` y AppImage se +siguen generando en cada versión, por si prefieres instalarlos a mano. + +## Compilar e instalar en local Instala en `~/.local` (sin root) con: @@ -292,11 +313,13 @@ por defecto (no guarda preferencias) y avisa por stderr. Hay dos manifiestos dirigidos al runtime GNOME 51: [packaging/flatpak](packaging/flatpak) compila desde un commit fijado y es el que se envía a Flathub, y [build-aux/flatpak](build-aux/flatpak) compila el -directorio de trabajo. Los dos son YAML y leen el mismo `cargo-sources.json`, -generado con +directorio de trabajo. La ficha publicada vive en +[flathub/io.github.gnacho.Scribe](https://github.com/flathub/io.github.gnacho.Scribe), +y ahí se actualiza cada versión. Los dos son YAML, y el `cargo-sources.json` que +usa `build-aux/flatpak` es un enlace simbólico a la copia canónica de +`packaging/flatpak/`, generada con [flatpak-cargo-generator](https://github.com/flatpak/flatpak-builder-tools/tree/master/cargo) -a partir del `Cargo.lock` commiteado. La copia canónica vive en -`packaging/flatpak/`; la de `build-aux/flatpak/` es un enlace simbólico a ella: +a partir del `Cargo.lock` commiteado: ```sh cargo generate-lockfile diff --git a/README.md b/README.md index 423bdca..7305eb8 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@

+ Flathub Release License: AGPL-3.0-or-later

@@ -25,7 +26,13 @@ engine. See it in action at [scribe.cloudless.club](https://scribe.cloudless.club): every feature working, screenshots in light and dark, a live typing demo and install -instructions for .deb, .rpm, AppImage and AUR. +instructions for Flathub, .deb, .rpm, AppImage and AUR. + +Available on Flathub: + +```sh +flatpak install flathub io.github.gnacho.Scribe +``` ## Why does this exist? @@ -274,7 +281,22 @@ Fedora: sudo dnf install gtk4-devel libadwaita-devel gtksourceview5-devel enchant2-devel glib2-devel ``` -## Install +## Install from Flathub + +Flathub is the easiest way to install Scribe, and it updates with the rest of +your system: + +```sh +flatpak install flathub io.github.gnacho.Scribe +flatpak run io.github.gnacho.Scribe +``` + +The listing is at [flathub.org/apps/io.github.gnacho.Scribe](https://flathub.org/apps/io.github.gnacho.Scribe). +It ships x86_64 and aarch64 builds. The `.deb`, `.rpm` and AppImage packages +below are built for every release as well, if you prefer to install them by +hand. + +## Build and install locally Install to `~/.local` (no root) with: @@ -312,11 +334,13 @@ are not saved) and logs a warning to stderr. Two manifests target the GNOME 51 runtime: [packaging/flatpak](packaging/flatpak) builds from a pinned git commit and is the one submitted to Flathub, while -[build-aux/flatpak](build-aux/flatpak) builds the local checkout. Both are YAML -and both read the same `cargo-sources.json`, generated with +[build-aux/flatpak](build-aux/flatpak) builds the local checkout. The published +listing lives in [flathub/io.github.gnacho.Scribe](https://github.com/flathub/io.github.gnacho.Scribe), +and that is where each release is bumped. Both are YAML, and the +`cargo-sources.json` used by `build-aux/flatpak` is a symlink to the canonical +copy in `packaging/flatpak/`, generated with [flatpak-cargo-generator](https://github.com/flatpak/flatpak-builder-tools/tree/master/cargo) -from the committed `Cargo.lock`. The canonical copy lives in -`packaging/flatpak/`; the one in `build-aux/flatpak/` is a symlink to it: +from the committed `Cargo.lock`: ```sh cargo generate-lockfile