Skip to content

minor: update readme #2

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
zhourrr merged 2 commits into from
Dec 30, 2025
Merged

minor: update readme #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b53522b
minor: update readme
zhourrr Dec 30, 2025
80b5065
minor: update python version in ReadMe
zhourrr Dec 30, 2025
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
28 changes: 5 additions & 23 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,30 +36,12 @@ pip install zvec

**Requirements**:

- Python 3.9
- **Supported platforms**: Linux (x86_64) or macOS (ARM64/x86_64)
- Python 3.10 - 3.12
- **Supported platforms**:
- Linux (x86_64)
- macOS (ARM64/x86_64)

### Building from Source

If you prefer to build Zvec from source, you can clone the repository and install it locally.
**Note**: *The repository includes Git submodules, so cloning may take a few minutes depending on your network*.

```bash
# Clone the repository
git clone --recurse-submodules https://github.com/GraphScope/zvec.git
cd zvec

# Install from source
pip install .
```

**Build Requirements**:

- Python 3.9 or higher
- **Supported platforms**: Linux (x86_64) or macOS (ARM64/x86_64)
- C++17 compatible compiler

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

## ⚡ One-Minute Example

Expand Down
Loading