rob
1fd92e19c9
Added bold instruction to read docs/updating-documentation.md before updating docs. This ensures AI assistants read the full visibility rules and procedures. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> |
||
|---|---|---|
| .. | ||
| CLAUDE.md.template | ||
| README.md.template | ||
| gitignore.template | ||
| overview.md.template | ||
| pyproject.toml.template | ||
| updating-documentation.md.template | ||
README.md.template
# {{PROJECT_TITLE}}
{{PROJECT_TAGLINE}}
## Installation
```bash
pip install -e .
```
## Usage
*TODO: Add usage instructions*
## Documentation
Full documentation is available at: https://pages.brrd.tech/{{GITEA_OWNER}}/{{PROJECT_NAME}}/
## Development
```bash
# Clone the repository
git clone {{GITEA_URL}}/{{GITEA_OWNER}}/{{PROJECT_NAME}}.git
cd {{PROJECT_NAME}}
# Create virtual environment
python -m venv .venv
source .venv/bin/activate
# Install for development
pip install -e ".[dev]"
# Run tests
pytest
```
## License
*TODO: Add license*