aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSulfurNitride <SulfurNitride@users.noreply.github.com>2026-03-13 12:53:51 -0500
committerSulfurNitride <SulfurNitride@users.noreply.github.com>2026-03-13 12:54:30 -0500
commit4ea3730c5ccf618763dbd5b9020bd1a0f25f2c80 (patch)
tree5d7a8bc2c065b8d44c0baca4f58609cf3f533dfc /README.md
parentde0bff7ebd87e8bf45ebd38800b92ca9aac00683 (diff)
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 <noreply@anthropic.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md35
1 files changed, 35 insertions, 0 deletions
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