silvanocerza commited on
Commit
f3fc704
1 Parent(s): cc59a7b

Update README.md with instructions

Browse files
Files changed (1) hide show
  1. README.md +22 -0
README.md CHANGED
@@ -1 +1,23 @@
1
  # Search all the docs demo
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  # Search all the docs demo
2
+
3
+ ## Getting started
4
+
5
+ First create your virtual env so you don't pollute your OS environment.
6
+ This demo has only been tested with Python 3.11, so I suggest you use that.
7
+
8
+ ```shell
9
+ mkvirtualenv search-all-the-docs
10
+ workon search-all-the-docs
11
+ ```
12
+
13
+ Install the dependencies:
14
+
15
+ ```shell
16
+ pip install -r requirements.txt
17
+ ```
18
+
19
+ And you're good to go!
20
+
21
+ ```shell
22
+ streamlit run main.py
23
+ ```