From 4ea3730c5ccf618763dbd5b9020bd1a0f25f2c80 Mon Sep 17 00:00:00 2001 From: SulfurNitride Date: Fri, 13 Mar 2026 12:53:51 -0500 Subject: Update README: add Building section and NixOS runtime requirements - Replace Flatpak build/install instructions with Docker-based build.sh - Add Runtime Requirements section with unbundled library list - Add NixOS nix-ld configuration snippet (from PR #37 by Anseryde) - Update Installing section to reflect native tarball distribution Co-Authored-By: Claude Sonnet 4.6 --- README.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 7b389a1..fe123f3 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,41 @@ If you want to support the things I put out, I do have a [Ko-Fi](https://ko-fi.c ## Building +Fluorine Manager is built inside a Docker/Podman container — no host toolchain setup required. + +**Prerequisites:** Docker or Podman + +```bash +./build.sh # Build portable .tar.gz +``` + +The default output is `build/fluorine-manager.tar.gz` — extract anywhere and run `./fluorine-manager`. + +### Runtime Requirements (Mainly NixOS) + +- Steam must be installed so that Proton is available. +- The following libraries are **not bundled** and must be available on your system: + - `libEGL` + - `libGL` + - `libGLX` + - `libstdc++` + - `libX11` + - `libxkbcommon` + +On most distros these are already present or installable via your package manager. + +**NixOS:** Use `nix-ld` to expose the unbundled libraries. Add them to `programs.nix-ld.libraries` in your `configuration.nix`: + +```nix +programs.nix-ld.enable = true; +programs.nix-ld.libraries = with pkgs; [ + libGL + libGLX + xorg.libX11 + libxkbcommon + stdenv.cc.cc.lib # libstdc++ +]; +``` ## Known Limitations -- cgit v1.3.1