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
This commit is contained in:
FSSCoding 2025-09-06 14:27:28 +10:00
parent 072326446f
commit 5912947d4b
2 changed files with 45 additions and 10 deletions

31
ENHANCEMENTS.md Normal file
View File

@ -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

View File

@ -81,22 +81,26 @@ FSS-Mini-RAG offers **two distinct experiences** optimized for different use cas
**Step 1: Install** **Step 1: Install**
```bash ```bash
# Linux/macOS # Clone the repository
./install_mini_rag.sh git clone https://github.com/FSSCoding/Fss-Mini-Rag.git
cd Fss-Mini-Rag
# Windows # Install using pip (creates global rag-mini command)
install_windows.bat python3 -m venv .venv
source .venv/bin/activate # Linux/macOS
# .venv\Scripts\activate # Windows
pip install -e .
``` ```
**Step 2: Start Using** **Step 2: Start Using**
```bash ```bash
# Beginners: Interactive interface # Navigate to any project and search
./rag-tui # Linux/macOS cd ~/my-project
rag.bat # Windows rag-mini init . # Index current project
rag-mini search . "authentication logic"
# Experienced users: Direct commands # Or use the legacy interface
./rag-mini index ~/project # Index your project ./rag-tui # Interactive interface
./rag-mini search ~/project "your query"
``` ```
That's it. No external dependencies, no configuration required, no PhD in computer science needed. That's it. No external dependencies, no configuration required, no PhD in computer science needed.