mirror of
https://github.com/khoaliber/khoj.git
synced 2026-03-06 05:39:12 +00:00
Add Interface Screenshots to Readme
This commit is contained in:
12
Readme.md
12
Readme.md
@@ -12,6 +12,7 @@
|
|||||||
- [Demo](#Demo)
|
- [Demo](#Demo)
|
||||||
- [Description](#Description)
|
- [Description](#Description)
|
||||||
- [Analysis](#Analysis)
|
- [Analysis](#Analysis)
|
||||||
|
- [Interfaces](#Interfaces)
|
||||||
- [Architecture](#Architecture)
|
- [Architecture](#Architecture)
|
||||||
- [Setup](#Setup)
|
- [Setup](#Setup)
|
||||||
- [Install](#1-Install)
|
- [Install](#1-Install)
|
||||||
@@ -57,7 +58,11 @@
|
|||||||
- The results do not have any words used in the query
|
- The results do not have any words used in the query
|
||||||
- *Based on the top result it seems the re-ranking model understands that Emacs is an editor?*
|
- *Based on the top result it seems the re-ranking model understands that Emacs is an editor?*
|
||||||
- The results incrementally update as the query is entered
|
- The results incrementally update as the query is entered
|
||||||
- The results are re-ranked, for better accuracy, once user is idle
|
- The results are re-ranked, for better accuracy, once user hits enter
|
||||||
|
|
||||||
|
### Interfaces
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
## Architecture
|
## Architecture
|
||||||
|
|
||||||
@@ -75,13 +80,16 @@
|
|||||||
```
|
```
|
||||||
|
|
||||||
### 3. Configure
|
### 3. Configure
|
||||||
|
|
||||||
1. Enable content types and point to files to search in the First Run Screen that pops up on app start*
|
1. Enable content types and point to files to search in the First Run Screen that pops up on app start*
|
||||||
2. Click configure* and wait. The app will load ML model, generates embeddings and exposes the search API
|
2. Click configure* and wait. The app will load ML model, generates embeddings and exposes the search API
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
## Use
|
## Use
|
||||||
|
|
||||||
- **Khoj via Web**
|
- **Khoj via Web**
|
||||||
- Open <http://localhost:8000/>
|
- Open <http://localhost:8000/> via desktop interface or directly
|
||||||
- **Khoj via Emacs**
|
- **Khoj via Emacs**
|
||||||
- [Install](https://github.com/debanjum/khoj/tree/master/src/interface/emacs#installation) [khoj.el](./src/interface/emacs/khoj.el)
|
- [Install](https://github.com/debanjum/khoj/tree/master/src/interface/emacs#installation) [khoj.el](./src/interface/emacs/khoj.el)
|
||||||
- Run `M-x khoj <user-query>`
|
- Run `M-x khoj <user-query>`
|
||||||
|
|||||||
BIN
docs/interfaces.png
Normal file
BIN
docs/interfaces.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 606 KiB |
Reference in New Issue
Block a user