docs: replace long dashes, document icons, emoji and avatar rules

Update the status of the client UX defects handled by the interface work.
This commit is contained in:
Loki 2026-10-25 10:26:02 +01:00
parent 220af2d6a4
commit ca3465daa5
Signed by: boba
GPG key ID: 253067914055423B
19 changed files with 311 additions and 303 deletions

View file

@ -1,4 +1,4 @@
# VNOX — Client
# VNOX - Client
> Native desktop client for VNOX. Voice, text, no cloud.
@ -10,12 +10,12 @@
## What is this?
The official desktop client for [VNOX](https://github.com/loki5512344/Vnox) — a self-hosted voice and text communication platform. Connects to a VNOX server over the LNEx protocol.
The official desktop client for [VNOX](https://github.com/loki5512344/Vnox) - a self-hosted voice and text communication platform. Connects to a VNOX server over the LNEx protocol.
- Connects to gateway via **TCP** (text, auth, channels, guilds, DMs)
- Connects to voice node via **UDP** (encrypted Opus voice packets)
- Opus audio encoding/decoding with adaptive jitter buffer
- Native UI built with **Slint** — no Electron, no web views
- Native UI built with **Slint** - no Electron, no web views
---
@ -73,13 +73,13 @@ See [docs/00-status.md](docs/00-status.md) for a full breakdown.
Linux builds also need audio/protocol prerequisites and FreeType/fontconfig development libraries (`libfreetype6-dev libfontconfig1-dev` on Ubuntu); native file selection uses the desktop portal.
```bash
# Terminal 1 — gateway
# Terminal 1 - gateway
cargo run -p vnox-gateway -- --config dev/config.toml
# Terminal 2 — voice node
# Terminal 2 - voice node
cargo run -p vnox-voice-node -- --config dev/config.toml
# Terminal 3 — client
# Terminal 3 - client
cargo run -p vnox-client
```
@ -87,7 +87,7 @@ The client connects to `127.0.0.1:7600` by default. You can change the address i
### Opus on Windows
`audiopus_sys` builds libopus from source via CMake. CMake 4.x policy flag is already set in `.cargo/config.toml` — no manual steps needed.
`audiopus_sys` builds libopus from source via CMake. CMake 4.x policy flag is already set in `.cargo/config.toml` - no manual steps needed.
---
@ -129,5 +129,5 @@ src/
## License
Client code: **GPL-3.0** — see [LICENSE](LICENSE)
Client code: **GPL-3.0** - see [LICENSE](LICENSE)
LNEx protocol specification: **CC0** (public domain)