Skip to content

Commit 86d20ee

Browse files
authored
docs: fix links in readme (#132)
These were not pointing to anything since the building guide is in the docs. I've linked it directly to our deployed docs.
1 parent 26d0e33 commit 86d20ee

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ curl -fsSL https://raw.githubusercontent.com/mozilla-ai/encoderfile/main/install
137137
chmod +x encoderfile
138138
```
139139

140-
> **Note for Windows users:** Pre-built binaries are not available for Windows. Please see [BUILDING.md](BUILDING.md) for instructions on building from source.
140+
> **Note for Windows users:** Pre-built binaries are not available for Windows. Please see our guide on [building from source](https://mozilla-ai.github.io/encoderfile/latest/reference/building/) for instructions on building from source.
141141
142142
Move the binary to a location in your PATH:
143143
```bash
@@ -151,7 +151,7 @@ mv encoderfile ~/.local/bin/
151151

152152
### Option 2: Build CLI Tool from Source
153153

154-
See [BUILDING.md](BUILDING.md) for detailed instructions on building the CLI tool from source.
154+
See our guide on [building from source](https://mozilla-ai.github.io/encoderfile/latest/reference/building/) for detailed instructions on building the CLI tool from source.
155155

156156
Quick build:
157157
```bash
@@ -378,7 +378,7 @@ Run as a Model Context Protocol server:
378378

379379
Once you have the `encoderfile` CLI tool installed, you can build binaries from any compatible HuggingFace model.
380380

381-
See [BUILDING.md](BUILDING.md) for detailed instructions including:
381+
See our guide on [building from source](https://mozilla-ai.github.io/encoderfile/latest/reference/building/) for detailed instructions including:
382382

383383
- How to export models to ONNX format
384384
- Configuration file options

docs/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ curl -fsSL https://raw.githubusercontent.com/mozilla-ai/encoderfile/main/install
137137
chmod +x encoderfile
138138
```
139139

140-
> **Note for Windows users:** Pre-built binaries are not available for Windows. Please see [BUILDING.md](BUILDING.md) for instructions on building from source.
140+
> **Note for Windows users:** Pre-built binaries are not available for Windows. Please see our guide on [building from source](https://mozilla-ai.github.io/encoderfile/latest/reference/building/) for instructions on building from source.
141141
142142
Move the binary to a location in your PATH:
143143
```bash
@@ -151,7 +151,7 @@ mv encoderfile ~/.local/bin/
151151

152152
### Option 2: Build CLI Tool from Source
153153

154-
See [BUILDING.md](BUILDING.md) for detailed instructions on building the CLI tool from source.
154+
See our guide on [building from source](https://mozilla-ai.github.io/encoderfile/latest/reference/building/) for detailed instructions on building the CLI tool from source.
155155

156156
Quick build:
157157
```bash
@@ -378,7 +378,7 @@ Run as a Model Context Protocol server:
378378

379379
Once you have the `encoderfile` CLI tool installed, you can build binaries from any compatible HuggingFace model.
380380

381-
See [BUILDING.md](BUILDING.md) for detailed instructions including:
381+
See our guide on [building from source](https://mozilla-ai.github.io/encoderfile/latest/reference/building/) for detailed instructions including:
382382

383383
- How to export models to ONNX format
384384
- Configuration file options

0 commit comments

Comments
 (0)