diff --git a/README.md b/README.md index b2ae5b9..7fdf9bb 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,56 @@ # explore-agentic -Agentic exploration project. \ No newline at end of file +Sample Python project with uv, pytest, and Gitea Actions CI/CD. + +## Setup + +```bash +# Install dependencies +uv sync + +# Activate virtual environment +source .venv/bin/activate +``` + +## Development + +```bash +# Install with test dependencies +uv sync --extra test + +# Run tests +uv run pytest tests/ -v +``` + +## CI/CD + +This project uses Gitea Actions for CI. The workflow runs on push and pull requests. + +Workflow: `.gitea/workflows/test.yaml` + +## OpenCode Configuration + +This project uses OpenCode with custom MCP servers and skills. + +### MCP Servers + +- **context7**: Documentation lookup +- **gitea**: Repository interaction +- **sentry**: Error tracking (requires API key) + +### Skills + +- **commit-message**: Conventional Commits format + +## Project Structure + +``` +. +├── src/ # Source code +├── tests/ # Unit tests +├── .gitea/workflows/ # CI/CD workflows +├── .opencode/ # OpenCode config +│ └── skills/ # Custom skills +├── pyproject.toml # uv project config +└── uv.lock # Locked dependencies +``` \ No newline at end of file