Spaces:
Running
Running
XThomasBU
commited on
Update README.md
Browse files
README.md
CHANGED
@@ -1,7 +1,34 @@
|
|
1 |
-
|
|
|
|
|
|
|
|
|
2 |
|
3 |
```bash
|
4 |
pip install edubotics-core
|
5 |
```
|
6 |
|
7 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# Edubotics-Core Setup
|
2 |
+
|
3 |
+
## Installation
|
4 |
+
|
5 |
+
To install `edubotics-core`, run the following command:
|
6 |
|
7 |
```bash
|
8 |
pip install edubotics-core
|
9 |
```
|
10 |
|
11 |
+
## Documentation
|
12 |
+
|
13 |
+
For detailed instructions on the initial setup (setting up .env file, required Keys, etc), please refer to our [documentation](http://docs.edubotics.ai).
|
14 |
+
|
15 |
+
### Templates
|
16 |
+
|
17 |
+
To get started, check out the templates located in the `apps/` directory.
|
18 |
+
|
19 |
+
### Config Files
|
20 |
+
|
21 |
+
- **config.yml**: This file controls various chatbot settings such as the default vector store and architecture type.
|
22 |
+
- **project_config.yml**: Use this file to customize settings specific to your project.
|
23 |
+
|
24 |
+
## Create Your Vectorstore
|
25 |
+
|
26 |
+
Once you have set up your config files, you can create your vector store by running:
|
27 |
+
|
28 |
+
```bash
|
29 |
+
vectorstore_creator --config_file path_to_your_config.yml --project_config_file path_to_your_project_config.yml
|
30 |
+
```
|
31 |
+
|
32 |
+
## Start Your App
|
33 |
+
|
34 |
+
After creating your vector store, you can start up your app and get going!
|