Skip to content

Commit 3af6987

Browse files
Add docproc.yaml to .gitignore, improve CLI/uv install docs
Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent e508837 commit 3af6987

File tree

3 files changed

+13
-41
lines changed

3 files changed

+13
-41
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ dist/
1717
# Environment
1818
.env
1919
.venv/
20+
docproc.yaml
2021
.envrc
2122
.python-version
2223

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -92,31 +92,32 @@ Secrets (API keys, endpoints) come from environment variables or `.env`. See [.e
9292

9393
## Installation
9494

95-
### CLI only (Ollama, minimal — no local models)
96-
97-
For `doc proc --file input.pdf -o output.md` with Ollama as the provider (no transformers, torch, etc.):
95+
### CLI
9896

9997
```bash
100-
pip install docproc
101-
# or with uv
102-
uv tool install docproc
98+
# With uv (recommended — isolated install, adds docproc to PATH)
99+
uv tool install git+https://github.com/rithulkamesh/docproc.git
100+
101+
# Or with pip
102+
pip install git+https://github.com/rithulkamesh/docproc.git
103103
```
104104

105-
Requires Ollama running with a vision model (e.g. `ollama pull llava && ollama serve`). Use `docproc.cli.yaml` or set `primary_ai: ollama` in `docproc.yaml`.
105+
Then `docproc --file input.pdf -o output.md`. Requires Ollama with a vision model (`ollama pull llava && ollama serve`). Use `docproc.cli.yaml` or `primary_ai: ollama` in `docproc.yaml`.
106106

107107
### Server (API + RAG + frontend)
108108

109109
```bash
110-
pip install docproc[server]
110+
uv tool install 'docproc[server] @ git+https://github.com/rithulkamesh/docproc.git'
111+
# or pip install docproc[server]
111112
```
112113

113-
### From source
114+
### From source (dev)
114115

115116
```bash
116117
git clone https://github.com/rithulkamesh/docproc.git && cd docproc
117118
uv sync --python 3.12
118-
# or
119-
pip install -e .
119+
# Run: uv run docproc --file input.pdf -o output.md
120+
# Or install: uv pip install -e .
120121
```
121122

122123
## Usage

docproc.yaml

Lines changed: 0 additions & 30 deletions
This file was deleted.

0 commit comments

Comments
 (0)