From 7542ad62ed601a5030377f58d9599af6fa20f2bc Mon Sep 17 00:00:00 2001 From: Javier Torres Date: Mon, 15 Jun 2026 10:07:18 +0200 Subject: [PATCH 1/2] Add Windows-specific notes --- docs/reference/building.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/reference/building.md b/docs/reference/building.md index 07acfafb..0b03b620 100644 --- a/docs/reference/building.md +++ b/docs/reference/building.md @@ -75,6 +75,10 @@ This will: ## Building the CLI Tool +> **Note for Windows users:** Before starting the build process, set `ESAXX_DYNAMIC_LINK=1` to + enable the dynamic linking of the `esaxx-rs` library. Since this library forces static linking, + Mozilla.ai's fork is used instead. This fork only modifies the build process. + First, build the encoderfile CLI tool: ```bash @@ -203,6 +207,10 @@ encoderfile: tokenizer_path: ./models/tokenizer.json ``` +> **Note for Windows users:** Since precompiled binaries are not available + for Windows yet, make sure you use the `base_binary_path: target/release/encoderfile-runtime.exe` + property in the configuration file. + ### Step 3: Build the Encoderfile Build your encoderfile binary: From c60d79d0b1c24abcdc0ef60ce90ac0fd5def40f2 Mon Sep 17 00:00:00 2001 From: Javier Torres Date: Tue, 16 Jun 2026 08:46:29 +0200 Subject: [PATCH 2/2] Add runtime details --- docs/reference/building.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/reference/building.md b/docs/reference/building.md index 0b03b620..4d1e18d0 100644 --- a/docs/reference/building.md +++ b/docs/reference/building.md @@ -85,7 +85,9 @@ First, build the encoderfile CLI tool: cargo build --bin encoderfile --release ``` -The CLI binary will be created at `./target/release/encoderfile`. +The CLI binary will be created at `./target/release/encoderfile`. This step also +creates the base executable that powers each encoderfile at +`target/release/encoderfile-runtime`. Optionally, install it to your system: @@ -209,7 +211,8 @@ encoderfile: > **Note for Windows users:** Since precompiled binaries are not available for Windows yet, make sure you use the `base_binary_path: target/release/encoderfile-runtime.exe` - property in the configuration file. + property in the configuration file. This file is generated when + [bulding from source](#building-the-cli-tool). ### Step 3: Build the Encoderfile