Fixup README

This commit is contained in:
2025-10-18 02:20:30 -04:00
parent 42d2b88e79
commit 3e77ef3370
4 changed files with 10 additions and 38 deletions

View File

@@ -3,7 +3,7 @@
Relibre is a simple, free, and open-source landing-page generator—an alternative to HyperFollow—that produces a **single self-contained HTML file** you can host anywhere.
**Try the generator →** [`https://`](https://relibre.site)
**Try the generator →** [`https://relibre.site`](https://relibre.site)
---
@@ -15,43 +15,21 @@ Relibre is a simple, free, and open-source landing-page generator—an alternati
---
## Quick start (static site)
Open locally:
```bash
# simple Python server
python3 -m http.server 8080
# → http://localhost:8080
```
---
## Launch / self-host with Docker or Podman
Relibre ships multiple compose variants so you can choose your reverse proxy. All of them:
- build an internal `web` container that serves the static files
- expose a `proxy` on **localhost:8080** (HAProxy, Caddy, Apache httpd, or Nginx)
**Files:**
- `docker-compose.yml.haproxy`
- `docker-compose.yml.caddy`
- `docker-compose.yml.apache`
- `docker-compose.yml.nginx`
- `proxy/`
- `Dockerfile`
```bash
docker compose pull
docker compose up -d
```
---
## Native desktop build (Go webview app)
Builds a single executable that opens Relibre inside the OS webview. The app runs a tiny localhost server and can save the generated HTML directly to your **Downloads** folder.
### Prereqs
**Arch:**
sudo pacman -S --needed base-devel go webkit2gtk gtk3 pkgconf
### Build
```bash
make deps
make build
./relibre-app
@@ -61,7 +39,9 @@ make build
## Arch Linux (AUR) packaging
- **`relibre`** builds from source
```bash
makepkg -si
```
---
@@ -69,9 +49,9 @@ make build
Relibre works well as a Flatpak using the GNOME runtime (WebKitGTK included).
Build & run locally:
```bash
flatpak install -y org.gnome.Platform//46 org.gnome.Sdk//46
flatpak-builder --user --install --force-clean build-dir com.circlewithadot.Relibre.yml
flatpak run com.circlewithadot.Relibre
```