Skip to content

Commit

Permalink
Fixes typo in README (#8)
Browse files Browse the repository at this point in the history
  • Loading branch information
HenrikSpiegel committed Feb 29, 2024
1 parent dbba740 commit 5f17035
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 6 deletions.
4 changes: 3 additions & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,14 @@ This project supports two styles of githooks.

1. The first style is to use the githooks provided in the `.githooks` directory. To use these hooks, run the following command in the root of the project:
- These hooks are very simple just blocking the commit to protected branches.
``

```
git config --local core.hooksPath .githooks/
```

2. The second is to install the precommit tool (for linux) [precommit](https://pre-commit.com/).
- These are much more powerful and can be used to run checks on the code before it is committed.

```
pipx install pre-commit
# Then run in the root of repo:
Expand Down
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,13 +47,20 @@ This project supports two styles of githooks.
of the project:

- These hooks are very simple just blocking the commit to protected
branches. \`\` git config –local core.hooksPath .githooks/
branches.

<!-- -->

git config --local core.hooksPath .githooks/

2. The second is to install the precommit tool (for linux) [precommit](https://pre-commit.com/).
- These are much more powerful and can be used to run checks on the code before it is committed.
2. The second is to install the precommit tool (for linux)
[precommit](https://pre-commit.com/).

pipx install pre-commit \# Then run in the root of repo: pre-commit
install \`\`\`
- These are much more powerful and can be used to run checks on the code
before it is committed.

<!-- -->

pipx install pre-commit
# Then run in the root of repo:
pre-commit install

0 comments on commit 5f17035

Please sign in to comment.