diff --git a/README.md b/README.md index 98adf78..a5dda4e 100644 --- a/README.md +++ b/README.md @@ -67,13 +67,13 @@ Going beyond traditional human-in-the-loop systems, EvoScientist introduces an A - [🔌 MCP Integration](#-mcp-integration) - [📱 Channels](#-channels) - [📚 Acknowledgments](#-acknowledgments) -- [🏛️ EvoScientist Team](#-evoscientist-team) +- [👥 EvoScientist Team](#-evoscientist-team) - [🤝 Contributing](#-contributing) ## 📦 Installation > [!NOTE] -> Requires **Python 3.11+**. A virtual environment is recommended. +> Requires **Python 3.11+**. A virtual environment is strongly recommended — EvoScientist experiments may install ML libraries (PyTorch, transformers, etc.) that can conflict with your system packages. ### Quick Install @@ -109,6 +109,8 @@ git pull && pip install -e ".[dev]" +
+ ## 🔑 Configuration The easiest way to configure API keys is the interactive wizard: @@ -148,6 +150,8 @@ cp .env.example .env # then fill in your keys + + ## ⚡ Quick Start ```bash @@ -211,6 +215,8 @@ for state in EvoScientist_agent.stream( + + ## 🔌 MCP Integration Add external tools via [MCP](https://modelcontextprotocol.io/) servers with a single command: @@ -224,7 +230,9 @@ EvoSci mcp add sequential-thinking npx -- -y @modelcontextprotocol/server-sequen ``` > [!NOTE] -> For command options, config fields, tool routing, wildcard filtering, and troubleshooting, see the **[MCP Integration Guide](./EvoScientist/mcp)**. +> For command options, config fields, tool routing, wildcard filtering, and troubleshooting, see the **[MCP Integration Guide](https://github.com/EvoScientist/EvoScientist/tree/main/EvoScientist/mcp#model-context-protocol-integration)**. + + ## 📱 Channels @@ -247,7 +255,9 @@ channel_enabled: "telegram,discord,slack" The channel can also be started interactively with `/channel` in the CLI session. > [!NOTE] -> For per-channel setup guides, capability matrix, architecture details, and troubleshooting, see the **[Channel Integration Guide](./EvoScientist/channels)**. +> For per-channel setup guides, capability matrix, architecture details, and troubleshooting, see the **[Channel Integration Guide](https://github.com/EvoScientist/EvoScientist/tree/main/EvoScientist/channels#channels)**. + + ## 📚 Acknowledgments @@ -260,7 +270,7 @@ We thank the authors for their valuable contributions to the open-source communi -## 🏛️ EvoScientist Team +## 👥 EvoScientist Team