From 2f6284872d50d2c2157c8014e70908b3fe2abce1 Mon Sep 17 00:00:00 2001 From: Debanjum Singh Solanky Date: Mon, 20 Mar 2023 15:18:19 -0600 Subject: [PATCH] Mention Khoj needs Python version 3.10 or lower in docs --- README.md | 2 +- src/interface/emacs/README.org | 2 +- src/interface/obsidian/README.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 81d25f9e..9f4ca231 100644 --- a/README.md +++ b/README.md @@ -107,7 +107,7 @@ https://user-images.githubusercontent.com/6413477/184735169-92c78bf1-d827-4663-9 ## Setup These are the general setup instructions for Khoj. -- Make sure [python](https://realpython.com/installing-python/) and [pip](https://pip.pypa.io/en/stable/installation/) are installed on your machine +- Make sure [python](https://realpython.com/installing-python/) (version 3.10 or lower) and [pip](https://pip.pypa.io/en/stable/installation/) are installed on your machine - Check the [Khoj.el Readme](https://github.com/debanjum/khoj/tree/master/src/interface/emacs#Setup) to setup Khoj with Emacs - Check the [Khoj Obsidian Readme](https://github.com/debanjum/khoj/tree/master/src/interface/obsidian#Setup) to setup Khoj with Obsidian
Its simpler as it can skip the configure step below. diff --git a/src/interface/emacs/README.org b/src/interface/emacs/README.org index 77211b91..2f2d0fdc 100644 --- a/src/interface/emacs/README.org +++ b/src/interface/emacs/README.org @@ -27,7 +27,7 @@ [[/docs/khoj_on_emacs.png]] ** Setup -/Make sure [[https://realpython.com/installing-python/][python]] and [[https://pip.pypa.io/en/stable/installation/][pip]] are installed on your machine/ +/Make sure [[https://realpython.com/installing-python/][python]] (version 3.10 or lower) and [[https://pip.pypa.io/en/stable/installation/][pip]] are installed on your machine/ *** 1. Setup Backend #+begin_src shell diff --git a/src/interface/obsidian/README.md b/src/interface/obsidian/README.md index 3426abad..b3195bb0 100644 --- a/src/interface/obsidian/README.md +++ b/src/interface/obsidian/README.md @@ -44,7 +44,7 @@ https://user-images.githubusercontent.com/6413477/210486007-36ee3407-e6aa-4185-8 ![](https://github.com/debanjum/khoj/blob/master/src/interface/obsidian/docs/khoj_on_obsidian_0.2.5.png?) ## Setup -- *Make sure [python](https://realpython.com/installing-python/) and [pip](https://pip.pypa.io/en/stable/installation/) are installed on your machine* +- *Make sure [python](https://realpython.com/installing-python/) (version 3.10 or lower) and [pip](https://pip.pypa.io/en/stable/installation/) are installed on your machine* - *Ensure you follow the ordering of the setup steps. Install the plugin after starting the khoj backend. This allows the plugin to configure the khoj backend* ### 1. Setup Backend