From 60eaa8165c34e8b5c6084233371ac9714132d175 Mon Sep 17 00:00:00 2001 From: yichuan520030910320 Date: Sun, 27 Jul 2025 16:36:30 -0700 Subject: [PATCH] fix precommit and fix redame install method --- .pre-commit-config.yaml | 7 ------- README.md | 13 ++++--------- 2 files changed, 4 insertions(+), 16 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index ee7c901..ad8fd0f 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -9,15 +9,8 @@ repos: - id: check-merge-conflict - id: debug-statements - - repo: https://github.com/psf/black - rev: 24.1.1 - hooks: - - id: black - language_version: python3 - - repo: https://github.com/astral-sh/ruff-pre-commit rev: v0.2.1 hooks: - id: ruff - args: [--fix] - id: ruff-format diff --git a/README.md b/README.md index dfd6b4d..84c171d 100755 --- a/README.md +++ b/README.md @@ -52,7 +52,11 @@ 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: + ```bash +git clone git@github.com:yichuan-w/LEANN.git leann +cd leann uv pip install leann ``` @@ -147,15 +151,6 @@ response = chat.ask( LEANN supports RAG on various data sources including documents (.pdf, .txt, .md), Apple Mail, Google Search History, WeChat, and more. -Our project provides many **ready-to-use examples**. If you installed LEANN via pip, you can clone our examples and run them immediately: - -```bash -git clone git@github.com:yichuan-w/LEANN.git leann -cd leann -``` - -> **Note:** If you built from source, you already have the examples and can skip cloning. - ### 📄 Personal Data Manager: Process Any Documents (.pdf, .txt, .md)! Ask questions directly about your personal PDFs, documents, and any directory containing your files!