docs: Refine docs (#200)

* Update docs

* update one demo video

* update docs

* remove the video

* move configuration file

* fix demo title
This commit is contained in:
you-n-g
2024-08-09 19:55:35 +08:00
committed by GitHub
parent b47ad23b87
commit 22dbb86fd4
9 changed files with 123 additions and 103 deletions
+2 -16
View File
@@ -23,19 +23,5 @@ We have established a basic method framework that continuously proposes hypothes
The figure above shows the main classes and how they fit into the workflow for those interested in the detailed code.
Detailed Design
=========================
Configuration
-------------
You can manually source the `.env` file in your shell before running the Python script:
Most of the workflow are controlled by the environment variables.
```sh
# Export each variable in the .env file; Please note that it is different from `source .env` without export
export $(grep -v '^#' .env | xargs)
# Run the Python script
python your_script.py
```
.. Detailed Design
.. ===============