From 342c72b1569e994d4e9b1d4ffccb733ca518d7a7 Mon Sep 17 00:00:00 2001
From: Debanjum Singh Solanky <debanjum@gmail.com>
Date: Mon, 15 Aug 2022 20:52:17 +0300
Subject: [PATCH] Update Readme Instructions to use Desktop GUI to configure
 App

- Configure app using the configure screen during first run.
  No config file args required to be passed via CLI by users

- Update instructions to copy khoj_sample.yml to default app configure
  file location and edit that. Instead of editing the khoj_sample.yml
  directly in source
---
 Readme.md | 40 ++++++++++++++++++++--------------------
 1 file changed, 20 insertions(+), 20 deletions(-)

diff --git a/Readme.md b/Readme.md
index 8d4f811b..7e19219c 100644
--- a/Readme.md
+++ b/Readme.md
@@ -65,20 +65,18 @@
 
 ## Setup
 ### 1. Install
-   ``` shell
-   pip install khoj-assistant
-   ```
+    ``` shell
+    pip install khoj-assistant
+    ```
 
-### 2. Configure
-   - Set `input-files` or `input-filter` in each relevant `content-type` section of [khoj_sample.yml](./config/khoj_sample.yml)
-     - Set `input-directories` field in `content-type.image` section
-   - Delete `content-type`, `processor` sub-sections irrelevant for your use-case
+### 2. Start App
+    ``` shell
+    khoj
+    ```
 
-### 3. Run
-   ``` shell
-   khoj -c=config/khoj_sample.yml -vv
-   ```
-   Loads ML model, generates embeddings and exposes API to search notes, images, transactions etc specified in config YAML
+### 3. Configure
+  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
 
 ## Use
 
@@ -88,7 +86,7 @@
   - [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>`
 - **Khoj via API**
-  - See [Khoj FastAPI Docs](http://localhost:8000/docs), [Khoj FastAPI ReDocs](http://localhost:8000/redocs)
+  - See the FastAPI [Swagger Docs](http://localhost:8000/docs), [ReDocs](http://localhost:8000/redocs)
 
 ## Upgrade
 ``` shell
@@ -98,7 +96,7 @@ pip install --upgrade khoj-assistant
 ## Troubleshoot
 
 - Symptom: Errors out complaining about Tensors mismatch, null etc
-  - Mitigation: Delete `content-type` > `image` section from `khoj_sample.yml`
+  - Mitigation: Disable `image` section on the desktop GUI
 
 - Symptom: Errors out with \"Killed\" in error message in Docker
   - Fix: Increase RAM available to Docker Containers in Docker Settings
@@ -108,7 +106,7 @@ pip install --upgrade khoj-assistant
 
 - The experimental [chat](localhost:8000/chat) API endpoint uses the [OpenAI API](https://openai.com/api/)
     - It is disabled by default
-    - To use it add your `openai-api-key` to config.yml
+    - To use it add your `openai-api-key` via the app configure screen
 
 ## Performance
 
@@ -140,13 +138,14 @@ pip install --upgrade khoj-assistant
    pip install -e .
    ```
 ##### 2. Configure
-   - Set `input-files` or `input-filter` in each relevant `content-type` section of `khoj_sample.yml`
+   - Copy the `config/khoj_sample.yml` to `~/.khoj/khoj.yml`
+   - Set `input-files` or `input-filter` in each relevant `content-type` section of `~/.khoj/khoj.yml`
      - Set `input-directories` field in `image` `content-type` section
-   - Delete `content-type`, `processor` sub-sections irrelevant for your use-case
+   - Delete `content-type` and `processor` sub-section(s) irrelevant for your use-case
 
 ##### 3. Run
    ``` shell
-   khoj -c=config/khoj_sample.yml -vv
+   khoj -vv
    ```
    Load ML model, generate embeddings and expose API to query notes, images, transactions etc specified in config YAML
 
@@ -209,13 +208,14 @@ docker-compose build --pull
    ```
 
 ##### 3. Configure
-   - Set `input-files` or `input-filter` in each relevant `content-type` section of `khoj_sample.yml`
+   - Copy the `config/khoj_sample.yml` to `~/.khoj/khoj.yml`
+   - Set `input-files` or `input-filter` in each relevant `content-type` section of `~/.khoj/khoj.yml`
      - Set `input-directories` field in `image` `content-type` section
    - Delete `content-type`, `processor` sub-sections irrelevant for your use-case
 
 ##### 4. Run
    ``` shell
-   python3 -m src.main config/khoj_sample.yml -vv
+   python3 -m src.main -vv
    ```
    Load ML model, generate embeddings and expose API to query notes, images, transactions etc specified in config YAML