Skip to content

docs: clarify README platforms and Python example #835

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
feihongxu0824 merged 7 commits into from
Oct 21, 2026
Merged

docs: clarify README platforms and Python example #835

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
859766b
docs: clarify README platforms and Python example
zhourrr Oct 21, 2026
65fb246
docs: simplify README platform headings and links
zhourrr Oct 21, 2026
9ecf2db
docs: restore platform section checkmark emoji
zhourrr Oct 21, 2026
272f2b3
docs: describe cross-platform application use cases
zhourrr Oct 21, 2026
99ef21e
docs: separate platform links and clarify link labels
zhourrr Oct 21, 2026
5923b31
docs: refine cross-platform support wording
zhourrr Oct 21, 2026
e3662b5
docs: identify Python examples in README headings
zhourrr Oct 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,16 +74,18 @@ Searching code or documents? Try **[zvec-grep](https://github.com/zvec-ai/zvec-g

Prefer a visual tool? Try **[Zvec Studio](https://github.com/zvec-ai/zvec-studio)** to browse data and debug queries — no code required.

### ✅ Supported Platforms
### ✅ Cross-Platform Support

Zvec supports all major platforms, including **Linux, macOS, and Windows**; see
the [platform support documentation](https://zvec.org/en/docs/db/platforms/) for details.
**Linux · macOS · Windows · Android · iOS**

Zvec supports all major platforms — from servers and desktops to mobile devices.<br>
For more details, please see the [platform support documentation](https://zvec.org/en/docs/db/platforms/).

### 🛠️ Building from Source

If you prefer to build Zvec from source, please check the [Building from Source](https://zvec.org/en/docs/db/build/) guide.

## ⚡ One-Minute Example
## ⚡ One-Minute Python Example

```python
import zvec
Expand Down
10 changes: 6 additions & 4 deletions README_CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,16 +77,18 @@ Zvec 提供多语言官方 SDK：

想要图形界面？试试 **[Zvec Studio](https://github.com/zvec-ai/zvec-studio)**，零代码浏览数据与调试查询。

### ✅ 支持的平台
### ✅ 全平台支持

Zvec 支持 **Linux、macOS、Windows**
等主流平台，完整兼容性信息请参阅[全平台支持文档](https://zvec.org/zh/docs/db/platforms/)。
**Linux · macOS · Windows · Android · iOS**

Zvec 提供全平台支持，覆盖服务器、桌面和移动设备。<br>
如需了解更多细节，请查阅[平台支持文档](https://zvec.org/zh/docs/db/platforms/)。

### 🛠️ 源码构建

如需从源码构建 Zvec，请参考[源码构建指南](https://zvec.org/zh/docs/db/build/)。

## ⚡ 一分钟上手
## ⚡ 一分钟上手（Python）

```python
import zvec
Expand Down
Loading