Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# rust-template
# Rust Template

[![Template](https://github.com/ahcodedev/rust-template/actions/workflows/template.yml/badge.svg?branch=main)](https://github.com/ahcodedev/rust-template/actions/workflows/template.yml)
[![gitleaks](https://img.shields.io/badge/protected%20by-gitleaks-blue)](https://github.com/gitleaks/gitleaks)

Rust project template for [Copier](https://copier.readthedocs.io/).

Expand Down
10 changes: 10 additions & 0 deletions copier.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,16 @@ description:
help: Short description of the project
default: ""

github_owner:
type: str
help: GitHub user or organization that will host the repository (used for README badges)
default: ""

github_repo:
type: str
help: GitHub repository name (used for README badges)
default: "{{ project_name }}"

copyright_year:
type: str
help: Year used in the LICENSE copyright line
3 changes: 3 additions & 0 deletions template/README.md.jinja
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# {{ project_name }}

[![Rust](https://github.com/{{ github_owner }}/{{ github_repo }}/actions/workflows/rust.yml/badge.svg?branch=main)](https://github.com/{{ github_owner }}/{{ github_repo }}/actions/workflows/rust.yml)
[![gitleaks](https://img.shields.io/badge/protected%20by-gitleaks-blue)](https://github.com/gitleaks/gitleaks)

{{ description }}

## Setup
Expand Down
Loading