Add download instructions, license visibility, disable contributions
- Download section with ZIP option for non-Git users - License type visible in header and footer - Tested On section - Status and last-updated in header - Issues, PRs, and wiki disabled via Forgejo API
This commit is contained in:
parent
8224cacaeb
commit
1000f9a75d
1 changed files with 38 additions and 10 deletions
48
README.md
48
README.md
|
|
@ -1,7 +1,9 @@
|
|||
# Multimodal RAG with Gemini Embedding 2 and Claude Code
|
||||
|
||||
Search across PDFs, images, and documents using plain English.
|
||||
No coding required. Claude Code builds everything from prompts.
|
||||
**Search across PDFs, images, and documents using plain English.**
|
||||
No coding required. Claude Code builds everything from four prompts.
|
||||
|
||||
`MIT License` · `Last updated: March 2026` · `Status: Complete, maintained`
|
||||
|
||||

|
||||
|
||||
|
|
@ -11,7 +13,7 @@ No coding required. Claude Code builds everything from prompts.
|
|||
|
||||
## Table of Contents
|
||||
|
||||
- [Quick Start](#quick-start)
|
||||
- [Download](#download)
|
||||
- [What This Does](#what-this-does)
|
||||
- [Prerequisites](#prerequisites)
|
||||
- [Step-by-Step Guide](#step-by-step-guide)
|
||||
|
|
@ -20,19 +22,26 @@ No coding required. Claude Code builds everything from prompts.
|
|||
- [Costs](#costs)
|
||||
- [Troubleshooting](#troubleshooting)
|
||||
- [How It Works](#how-it-works)
|
||||
- [Tested On](#tested-on)
|
||||
- [License](#license)
|
||||
|
||||
## Quick Start
|
||||
## Download
|
||||
|
||||
**Option A: Download ZIP (no Git required)**
|
||||
|
||||
1. Click the green **Code** button at the top of this page
|
||||
2. Select **Download ZIP**
|
||||
3. Unzip the folder and open it in your terminal
|
||||
|
||||
**Option B: Git clone**
|
||||
|
||||
```bash
|
||||
git clone https://git.thedharmalab.com/ktg/multimodal-rag-guide.git
|
||||
cd multimodal-rag-guide
|
||||
claude
|
||||
```
|
||||
|
||||
Then paste the prompt from [`prompts/01-setup.md`](prompts/01-setup.md) into Claude Code.
|
||||
|
||||
Four prompts, 30 minutes, working multimodal search.
|
||||
Then start Claude Code by typing `claude` in the folder, and paste the
|
||||
first prompt from [`prompts/01-setup.md`](prompts/01-setup.md).
|
||||
|
||||
## What This Does
|
||||
|
||||
|
|
@ -78,11 +87,18 @@ No programming knowledge required.
|
|||
4. Select the free "Starter" plan
|
||||
5. Copy your API key from "API Keys"
|
||||
|
||||
### Step 1: Clone and start Claude Code (5 minutes)
|
||||
### Step 1: Get the files and start Claude Code (5 minutes)
|
||||
|
||||
Download and unzip (see [Download](#download) above), or:
|
||||
|
||||
```bash
|
||||
git clone https://git.thedharmalab.com/ktg/multimodal-rag-guide.git
|
||||
cd multimodal-rag-guide
|
||||
```
|
||||
|
||||
Open your terminal in the folder and type:
|
||||
|
||||
```bash
|
||||
claude
|
||||
```
|
||||
|
||||
|
|
@ -183,6 +199,15 @@ generates answers.
|
|||
For plain-English explanations of embeddings, vector databases, RAG,
|
||||
and chunking, see [concepts.md](concepts.md).
|
||||
|
||||
## Tested On
|
||||
|
||||
- macOS (Apple Silicon and Intel)
|
||||
- Claude Code with Claude Pro subscription
|
||||
- Gemini Embedding 2 free tier
|
||||
- Pinecone free tier (Starter plan)
|
||||
|
||||
Should work on any system that runs Claude Code (macOS, Linux, Windows via WSL).
|
||||
|
||||
## Built With
|
||||
|
||||
- [Claude Code](https://claude.ai) by Anthropic
|
||||
|
|
@ -191,7 +216,10 @@ and chunking, see [concepts.md](concepts.md).
|
|||
|
||||
## License
|
||||
|
||||
[MIT](LICENSE)
|
||||
This project is licensed under the [MIT License](LICENSE). You are free
|
||||
to use, modify, and distribute it.
|
||||
|
||||
Example data (NASA images and PDFs) is in the public domain.
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue