From 5912947d4bb0d254d46736ee281e7a136332b644 Mon Sep 17 00:00:00 2001 From: FSSCoding Date: Sat, 6 Sep 2025 14:27:28 +1000 Subject: [PATCH] Update installation documentation for pip install method - Update Quick Start section to show new pip install workflow - Add ENHANCEMENTS.md for tracking path resolution feature - Replace old bash installer instructions with proper Python packaging --- ENHANCEMENTS.md | 31 +++++++++++++++++++++++++++++++ README.md | 24 ++++++++++++++---------- 2 files changed, 45 insertions(+), 10 deletions(-) create mode 100644 ENHANCEMENTS.md diff --git a/ENHANCEMENTS.md b/ENHANCEMENTS.md new file mode 100644 index 0000000..9301a3a --- /dev/null +++ b/ENHANCEMENTS.md @@ -0,0 +1,31 @@ +# FSS-Mini-RAG Enhancement Backlog + +## Path Resolution & UX Improvements + +### Current State +```bash +rag-mini search /full/absolute/path "query" +``` + +### Desired State +```bash +cd /my/project +rag-mini "authentication logic" # Auto-detects current directory, defaults to search +rag-mini . "query" # Explicit current directory +rag-mini ../other "query" # Relative path resolution +``` + +### Implementation Requirements +1. **Auto-detect current working directory** when no path specified +2. **Default to search command** when first argument is a query string +3. **Proper path resolution** using `pathlib.Path.resolve()` for all relative paths +4. **Maintain backwards compatibility** with existing explicit command syntax + +### Technical Details +- Modify `mini_rag/cli.py` argument parsing +- Add path resolution with `os.path.abspath()` or `pathlib.Path.resolve()` +- Make project_path optional (default to `os.getcwd()`) +- Smart command detection (if first arg doesn't match command, assume search) + +### Priority +High - Significant UX improvement for daily usage \ No newline at end of file diff --git a/README.md b/README.md index 289331f..d62a192 100644 --- a/README.md +++ b/README.md @@ -81,22 +81,26 @@ FSS-Mini-RAG offers **two distinct experiences** optimized for different use cas **Step 1: Install** ```bash -# Linux/macOS -./install_mini_rag.sh +# Clone the repository +git clone https://github.com/FSSCoding/Fss-Mini-Rag.git +cd Fss-Mini-Rag -# Windows -install_windows.bat +# Install using pip (creates global rag-mini command) +python3 -m venv .venv +source .venv/bin/activate # Linux/macOS +# .venv\Scripts\activate # Windows +pip install -e . ``` **Step 2: Start Using** ```bash -# Beginners: Interactive interface -./rag-tui # Linux/macOS -rag.bat # Windows +# Navigate to any project and search +cd ~/my-project +rag-mini init . # Index current project +rag-mini search . "authentication logic" -# Experienced users: Direct commands -./rag-mini index ~/project # Index your project -./rag-mini search ~/project "your query" +# Or use the legacy interface +./rag-tui # Interactive interface ``` That's it. No external dependencies, no configuration required, no PhD in computer science needed.