comp-chem/cp2k
1
0
Fork 0
mirror of https://github.com/cp2k/cp2k.git synced 2026-07-28 22:25:32 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

precommit: Touch up README.md

Browse source
This commit is contained in:
Ole Schütt 2020-08-25 22:37:17 +02:00 • committed by Ole Schütt
parent bb453db103
commit 84a01e9102
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
tools/precommit/README.md
View file

@ -17,7 +17,7 @@ source code:
to format Python scripts.
- [shellcheck](https://github.com/koalaman/shellcheck)
to analyze Shell scripts.
- [markdownlint](https://github.com/markdownlint/markdownlint)
- [markdownlint](https://github.com/DavidAnson/markdownlint)
to analyze Markdown files.
In contrast to the [CP2K-CI](https://github.com/cp2k/cp2k-ci) these tools
@ -25,7 +25,7 @@ process each file individually, which makes them much more lightweight.
## Install Git Hook
The [precommit.py](./precommit.py) script can be readily installed as git hook:
The [precommit.py](./precommit.py) script can be readily installed as a git hook:
```shell
ln -fs ../../tools/precommit/precommit.py .git/hooks/pre-commit
@ -57,7 +57,7 @@ Searching for files...
## Backups and Cache
Before precommit run an external tool on a file it create a backup copy in
Before precommit runs an external tool on a file it create a backup copy in
`obj/precommit`. If the tool leaves the file unmodified then the backup copy is
remove afterwards. If the tool modifies the file and precommit was invoked
without `--allow-modifications` then the backup copy is used to restore the