Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

get rid of "mirror" wording in README #6

Merged
merged 2 commits into from
Jan 28, 2024
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
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# copier-template-pre-commit-mirrors

This is a template for our pre-commit mirrors.
This is a template for our conda based pre-commit hooks.

To create a new mirror, you can run the following command
To create a new hook, you can run the following command

```bash
pixi run generate /path/to/mirror
pixi run generate /path/to/hook
```
2 changes: 1 addition & 1 deletion pixi.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "copier-template-pre-commit-mirrors"
description = "Copier template for our pre-commit mirrors"
description = "Copier template for our conda based pre-commit hooks"
authors = ["QuantCo <[email protected]>"]
channels = ["conda-forge"]
platforms = ["osx-arm64", "osx-64", "linux-64"]
Expand Down
4 changes: 2 additions & 2 deletions template/README.md.jinja
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# {{ tool }} mirror
# {{ tool }} pre-commit hook

Mirror of {{ tool }} for pre-commit with conda as a language.
pre-commit hook of {{ tool }} with conda as a `language` / package manager.

For pre-commit: see [here](https://github.com/pre-commit/pre-commit)

Expand Down