NickelEval.jl

commit 52c220ce69863b738893ddd654dfe325c5dc2392
parent 19de7ff5f79bf350eab6389988db5c3a0dfc713e
Author: Erik Loualiche <[email protected]>
Date:   Wed, 18 Mar 2026 14:05:28 -0400

Merge pull request #13 from LouLouLibs/docs/readme-hpc

Update README HPC instructions with build_ffi()
Diffstat:
M
README.md
 | 
13
++++++++++---

1 file changed, 10 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
@@ -152,15 +152,21 @@ NICKELEVAL_BUILD_FFI=true julia -e 'using Pkg; Pkg.build("NickelEval")'
 
 ### HPC / Slurm Clusters
 
-The pre-built Linux binary may fail on clusters with an older glibc. Build from source:
+The pre-built Linux binary requires glibc >= 2.29. On older systems (RHEL 8, CentOS 8), it will warn and fall back gracefully. Build from source inside Julia:
+
+```julia
+using NickelEval
+build_ffi()   # builds from source, no restart needed
+```
+
+This requires Rust. If `cargo` isn't available:
 
 ```bash
 curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
 source ~/.cargo/env
-NICKELEVAL_BUILD_FFI=true julia -e 'using Pkg; Pkg.build("NickelEval")'
 ```
 
-Restart Julia after building.
+Then run `build_ffi()` again.
 
 ## API Reference
 
@@ -173,6 +179,7 @@ Restart Julia after building.
 | `nickel_eval_file(path)` | Evaluate a `.ncl` file with import support |
 | `@ncl_str` | String macro for inline evaluation |
 | `check_ffi_available()` | Check if the C API library is loaded |
+| `build_ffi()` | Build C API library from source (requires Rust) |
 
 ### Export