Skip to content

Commit

Permalink
Update Readmes to use python -m pip install khoj-assistant
Browse files Browse the repository at this point in the history
Makes it easier to tell pip associated with which python is being
used. Easier to debug when users have different versions of python
installed (e.g 3.10 and 3.11)
  • Loading branch information
debanjum committed Apr 16, 2023
1 parent 453c84a commit d5000c6
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 6 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,10 +119,15 @@ These are the general setup instructions for Khoj.
Its simpler as it can skip the *configure* step below.

### 1. Install
- On Linux/MacOS
```shell
python -m pip install khoj-assistant
```

```shell
pip install khoj-assistant
```
- On Windows
```shell
py -m pip install khoj-assistant
```

### 2. Run

Expand Down
13 changes: 10 additions & 3 deletions src/interface/obsidian/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,16 @@ https://user-images.githubusercontent.com/6413477/210486007-36ee3407-e6aa-4185-8

### 1. Setup Backend
Open terminal/cmd and run below command to install and start the khoj backend
```shell
pip install khoj-assistant && khoj --no-gui
```
- On Linux/MacOS
```shell
python -m pip install khoj-assistant && khoj --no-gui
```

- On Windows
```shell
py -m pip install khoj-assistant && khoj --no-gui
```

### 2. Setup Plugin
1. Open [Khoj](https://obsidian.md/plugins?id=khoj) from the *Community plugins* tab in Obsidian settings panel
2. Click *Install*, then *Enable* on the Khoj plugin page in Obsidian
Expand Down

0 comments on commit d5000c6

Please sign in to comment.