From 877f23b022ff7e5b21688ec8cf2aee8fbf2e048c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jakub=20Musia=C5=82?=
 <111433005+SpectraL519@users.noreply.github.com>
Date: Sun, 24 Mar 2024 14:27:15 +0100
Subject: [PATCH] unix line endings

---
 README.md | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/README.md b/README.md
index 528520f..a0af400 100644
--- a/README.md
+++ b/README.md
@@ -483,6 +483,11 @@ Run the tests:
 
 ### Formatting
 
+> **NOTE:** To ensure new line encoding compatibility the project uses unix new line encoding.
+>
+> This can be set using the `git config --global core.autocrlf true` command.
+> More details can be found [here](https://docs.github.com/en/get-started/getting-started-with-git/configuring-git-to-handle-line-endings)
+
 > **NOTE:** The project uses `clang-format-17`.
 >
 > To install this tool on ubuntu run `sudo bash ./scripts/env/install_clang17_toolchain.sh`.