Add readme comment

Chatterino · Aug 1, 2023 · 21174b5 · 21174b5
1 parent 2d6df3d
commit 21174b5
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -44,6 +44,18 @@ git submodule update --init --recursive
 
 [Building on FreeBSD](../master/BUILDING_ON_FREEBSD.md)
 
+## Git blame
+
+This project has big commits in the history which for example update all line
+endings. To improve the output of git-blame, consider setting:
+
+```
+git config blame.ignoreRevsFile .git-blame-ignore-revs
+```
+
+This will ignore all revisions mentioned in the [`.git-blame-ignore-revs`
+file](./.git-blame-ignore-revs). GitHub does this by default.
+
 ## Code style
 
 The code is formatted using clang format in Qt Creator. [.clang-format](src/.clang-format) contains the style file for clang format.