From 57959947a14349b95d9209f78b28a2744e06eed7 Mon Sep 17 00:00:00 2001 From: Andy Lee Date: Tue, 29 Jul 2025 14:10:30 -0700 Subject: [PATCH] docs: Add collapsible section for CLI installation - Wrap CLI installation instructions in details/summary tags - Keep consistent with other collapsible sections in README - Improve document readability and navigation --- README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index df3f0f7..be7cfbf 100755 --- a/README.md +++ b/README.md @@ -43,17 +43,15 @@ LEANN achieves this through *graph-based selective recomputation* with *high-deg ### 📦 Prerequisites: Install uv (if you don't have it) -Install uv first if you don't have it: +[Install uv](https://docs.astral.sh/uv/getting-started/installation/#installation-methods) first if you don't have it. Typically, you can install it with: ```bash curl -LsSf https://astral.sh/uv/install.sh | sh ``` -📖 [Detailed uv installation methods →](https://docs.astral.sh/uv/getting-started/installation/#installation-methods) - ### 🚀 Quick Install -Clone the repository to access all examples, +Clone the repository to access all examples and try amazing applications, ```bash git clone https://github.com/yichuan-w/LEANN.git leann @@ -71,6 +69,8 @@ uv pip install leann

🔧 Build from Source (Recommended for development)

+ + ```bash @@ -398,7 +398,8 @@ Once the index is built, you can ask questions like: LEANN includes a powerful CLI for document processing and search. Perfect for quick document indexing and interactive chat. -### Installation +
+🔧 Click to expand: Installation Options If you followed the Quick Start, `leann` is already installed in your virtual environment: ```bash @@ -413,11 +414,12 @@ uv tool install leann # Now you can use leann from anywhere without activating venv leann --help - -# To update the global installation later -uv tool upgrade leann ``` +
+ + + ### Usage Examples ```bash