Skip to content

Commit

Permalink
Document our usage of clang-format
Browse files Browse the repository at this point in the history
  • Loading branch information
marcelm committed Apr 26, 2023
1 parent 0ac3971 commit bb68d93
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,15 @@ data, then builds strobealign as it is in your working copy and compares the
two produced BAM files. The baseline BAM is cached and re-used as long as the
baseline commit does not change.

## Code formatting

We use [clang-format](https://clang.llvm.org/docs/ClangFormat.html). You can
manually format a changed file by running
`clang-format -style=file src/filename.cpp` or (preferably) install
[pre-commit](https://pre-commit.com/) and run `pre-commit install` to add a
Git pre-commit hook that will run when you commit your changes and will
automatically reformat changed files touched by the commit.


V0.7 Performance
----------------
Expand Down

0 comments on commit bb68d93

Please sign in to comment.