Changes
This commit is contained in:
@@ -84,6 +84,18 @@ This project includes a complete suite of evals, based on the LiveKit Agents [te
|
||||
uv run pytest evals
|
||||
```
|
||||
|
||||
## Using this template repo for your own project
|
||||
|
||||
Once you've started your own project based on this repo, you should:
|
||||
|
||||
1. **Check in your `uv.lock`**: This file is currently untracked for the template, but you should commit it to your repository for reproducible builds and proper configuration management. (The same applies to `livekit.toml`, if you run your agents in LiveKit Cloud)
|
||||
|
||||
2. **Remove the git tracking test**: Delete the "Check files not tracked in git" step from `.github/workflows/tests.yml` since you'll now want this file to be tracked. These are just there for development purposes in the template repo itself.
|
||||
|
||||
## Deploying to production
|
||||
|
||||
This project is production-ready and includes a working `Dockerfile`. To deploy it to LiveKit Cloud or another environment, see the [deploying to production](https://docs.livekit.io/agents/ops/deployment/) guide.
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
||||
Reference in New Issue
Block a user