diff --git a/README.md b/README.md index acffaa9..687c9cc 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,18 @@ The project includes a complete [AGENTS.md](AGENTS.md) file for these assistants ## Dev Setup +Create a project from this template with the LiveKit CLI (recommended): + +```bash +lk cloud auth +lk agent init my-agent --template agent-starter-python +``` + +The CLI clones the template and configures your environment. Then follow the rest of this guide from [Run the agent](#run-the-agent). + +
+Alternative: manual setup without the CLI + Clone the repository and install dependencies to a virtual environment: ```console @@ -69,6 +81,8 @@ lk cloud auth lk app env -w -d .env.local ``` +
+ ## Run the agent Before your first run, you must download certain models such as [Silero VAD](https://docs.livekit.io/agents/build/turns/vad/) and the [LiveKit turn detector](https://docs.livekit.io/agents/build/turns/turn-detector/):