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
This commit is contained in:
18
README.md
18
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)
|
### 📦 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
|
```bash
|
||||||
curl -LsSf https://astral.sh/uv/install.sh | sh
|
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
|
### 🚀 Quick Install
|
||||||
|
|
||||||
Clone the repository to access all examples,
|
Clone the repository to access all examples and try amazing applications,
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/yichuan-w/LEANN.git leann
|
git clone https://github.com/yichuan-w/LEANN.git leann
|
||||||
@@ -71,6 +69,8 @@ uv pip install leann
|
|||||||
<details>
|
<details>
|
||||||
<summary>
|
<summary>
|
||||||
<h3>🔧 Build from Source (Recommended for development)</h3>
|
<h3>🔧 Build from Source (Recommended for development)</h3>
|
||||||
|
</summary>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
```bash
|
```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.
|
LEANN includes a powerful CLI for document processing and search. Perfect for quick document indexing and interactive chat.
|
||||||
|
|
||||||
### Installation
|
<details>
|
||||||
|
<summary><strong>🔧 Click to expand: Installation Options</strong></summary>
|
||||||
|
|
||||||
If you followed the Quick Start, `leann` is already installed in your virtual environment:
|
If you followed the Quick Start, `leann` is already installed in your virtual environment:
|
||||||
```bash
|
```bash
|
||||||
@@ -413,11 +414,12 @@ uv tool install leann
|
|||||||
|
|
||||||
# Now you can use leann from anywhere without activating venv
|
# Now you can use leann from anywhere without activating venv
|
||||||
leann --help
|
leann --help
|
||||||
|
|
||||||
# To update the global installation later
|
|
||||||
uv tool upgrade leann
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### Usage Examples
|
### Usage Examples
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|||||||
Reference in New Issue
Block a user