40 lines
557 B
Plaintext
40 lines
557 B
Plaintext
# {{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*
|