From 1f95d7b9821040405dc22898f898dc19adb728ec Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Moura?= Date: Mon, 11 Mar 2024 17:05:20 -0300 Subject: [PATCH] Improve tempalte readme --- src/crewai/cli/templates/README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/crewai/cli/templates/README.md b/src/crewai/cli/templates/README.md index 9a8af12be..b6ff402b4 100644 --- a/src/crewai/cli/templates/README.md +++ b/src/crewai/cli/templates/README.md @@ -21,9 +21,10 @@ poetry lock ```bash poetry install ``` - ### Customizing +**Add you `OPENAI_API_KEY` on the `.env` file** + - Modify `src/{{folder_name}}/config/agents.yaml` to define your agents - Modify `src/{{folder_name}}/config/tasks.yaml` to define your tasks - Modify `src/{{folder_name}}/crew.py` to add your own logic, tools and specific args @@ -39,6 +40,8 @@ poetry run {{folder_name}} This command initializes the {{name}} Crew, assembling the agents and assigning them tasks as defined in your configuration. +This example, unmodified, will run the create a `report.md` file with the output of a research on LLMs in the root folser + ## Understanding Your Crew The {{name}} Crew is composed of multiple AI agents, each with unique roles, goals, and tools. These agents collaborate on a series of tasks, defined in `config/tasks.yaml`, leveraging their collective skills to achieve complex objectives. The `config/agents.yaml` file outlines the capabilities and configurations of each agent in your crew.