diff --git a/.env.example b/.env.example index 79403ec..c6015e9 100644 --- a/.env.example +++ b/.env.example @@ -12,3 +12,6 @@ VOLCENGINE_TTS_APPID=xxx VOLCENGINE_TTS_ACCESS_TOKEN=xxx # VOLCENGINE_TTS_CLUSTER=volcano_tts # Optional, default is volcano_tts # VOLCENGINE_TTS_VOICE_TYPE=BV700_V2_streaming # Optional, default is BV700_V2_streaming + +# [!NOTE] +# For model settings and other configurations, please refer to `docs/configuration_guide.md` diff --git a/README.md b/README.md index 0a4664f..b3e2759 100644 --- a/README.md +++ b/README.md @@ -92,7 +92,7 @@ brew install marp-cli Optionally, install web UI dependencies via [pnpm](https://pnpm.io/installation): ```bash -cd web +cd deer-flow/web pnpm install ``` diff --git a/conf.yaml.example b/conf.yaml.example index a7d817b..872a989 100644 --- a/conf.yaml.example +++ b/conf.yaml.example @@ -1,3 +1,4 @@ +# [!NOTE] # Read the `docs/configuration_guide.md` carefully, and update the configurations to match your specific settings and requirements. # - Replace `api_key` with your own credentials # - Replace `base_url` and `model` name if you want to use a custom model diff --git a/docs/configuration_guide.md b/docs/configuration_guide.md index 54776c2..9b7ead8 100644 --- a/docs/configuration_guide.md +++ b/docs/configuration_guide.md @@ -1,5 +1,14 @@ # Configuration Guide +## Quick Settings + +Copy the `conf.yaml.example` file to `conf.yaml` and modify the configurations to match your specific settings and requirements. + +```bash +cd deer-flow +cp conf.yaml.example conf.yaml +``` + ## Which models does DeerFlow support? In DeerFlow, currently we only support non-reasoning models, which means models like OpenAI's o1/o3 or DeepSeek's R1 are not supported yet, but we will add support for them in the future.