From 4de1caa40f1e5a2125b7e2a264102731454d4672 Mon Sep 17 00:00:00 2001 From: yichuan520030910320 Date: Sun, 27 Jul 2025 17:00:28 -0700 Subject: [PATCH] fix redame install method --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 84c171d..b3daa41 100755 --- a/README.md +++ b/README.md @@ -52,14 +52,17 @@ LEANN provides two installation methods: **pip install** (quick and easy) and ** ### 🚀 Quick Install (Recommended for most users) -Our project provides many **ready-to-use examples**. If you installed LEANN via pip, you can clone our examples and run them immediately: +Our project provides many **ready-to-use examples**. Clone the repository to access all examples and run them immediately: ```bash git clone git@github.com:yichuan-w/LEANN.git leann cd leann +uv venv uv pip install leann ``` +> **Note:** This installs LEANN from PyPI and clones the repository to access our examples. Perfect for trying out LEANN or running the examples. For development or to use the latest features, see "Build from Source" below. + ### 🔧 Build from Source (Recommended for development) For development, we recommend building from source: @@ -73,19 +76,18 @@ git submodule update --init --recursive **macOS:** ```bash brew install llvm libomp boost protobuf zeromq pkgconf - - CC=$(brew --prefix llvm)/bin/clang CXX=$(brew --prefix llvm)/bin/clang++ uv sync ``` **Linux:** ```bash sudo apt-get install libomp-dev libboost-all-dev protobuf-compiler libabsl-dev libmkl-full-dev libaio-dev libzmq3-dev - # Install with HNSW backend (default, recommended for most users) uv sync ``` +> **Note:** This builds LEANN from source with editable installs. Use this for development, contributing, or to access the latest features and experimental capabilities. +