forked from CWAD/relibre
Fix README
This commit is contained in:
60
README.md
60
README.md
@@ -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.
|
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://circlewithadot.net/relibre)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -13,65 +13,19 @@ Relibre is a simple, free, and open-source landing-page generator—an alternati
|
|||||||
- Host it anywhere (Neocities, object storage, GitHub/Gitea Pages, your own server, IPFS, etc.)
|
- Host it anywhere (Neocities, object storage, GitHub/Gitea Pages, your own server, IPFS, etc.)
|
||||||
- Optional native desktop app (only Arch Linux and Flatpak supported for now)
|
- Optional native desktop app (only Arch Linux and Flatpak supported for now)
|
||||||
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Quick start (static site)
|
## Source build
|
||||||
|
|
||||||
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
|
|
||||||
---
|
|
||||||
|
|
||||||
## 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
|
|
||||||
make deps
|
make deps
|
||||||
make build
|
make build
|
||||||
./relibre-app
|
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Arch Linux (AUR) packaging
|
## Arch Linux (AUR)
|
||||||
|
|
||||||
- **`relibre`** – builds from source
|
```
|
||||||
|
makepkg -si
|
||||||
---
|
```
|
||||||
|
|
||||||
## Flatpak / Flathub
|
|
||||||
|
|
||||||
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
|
|
||||||
|
|||||||
Reference in New Issue
Block a user