Skip to content

Commit c9e51c7

Browse files
Re-binmagic524
authored andcommitted
docs(readme): flag Matrix channel as unsupported on Windows
HKUDS#3194 adds `; sys_platform != 'win32'` markers to `matrix-nio[e2e]` so `pip install nanobot-ai[matrix]` no longer fails on Windows — but it also no longer installs matrix-nio there. Without this note, Windows users get a silent half-install and discover the limitation only when the channel crashes at startup. Made-with: Cursor
1 parent 6cb0272 commit c9e51c7

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -442,6 +442,13 @@ Install Matrix dependencies first:
442442
pip install nanobot-ai[matrix]
443443
```
444444

445+
> [!NOTE]
446+
> Matrix is not supported on Windows. `matrix-nio[e2e]` depends on
447+
> `python-olm`, which has no pre-built Windows wheel and is skipped by the
448+
> `matrix` extra on `sys_platform == 'win32'`. The command above will still
449+
> succeed on Windows but without `matrix-nio` installed, so enabling the
450+
> Matrix channel will fail at startup. Use macOS, Linux, or WSL2.
451+
445452
**1. Create/choose a Matrix account**
446453

447454
- Create or reuse a Matrix account on your homeserver (for example `matrix.org`).

0 commit comments

Comments
 (0)