diff --git a/README.Rmd b/README.Rmd index 32f3317..d005af3 100644 --- a/README.Rmd +++ b/README.Rmd @@ -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: diff --git a/README.md b/README.md index c80bcdb..5e6e1da 100644 --- a/README.md +++ b/README.md @@ -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