aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGeckoEidechse <40122905+GeckoEidechse@users.noreply.github.com>2024-08-28 02:26:42 +0200
committerGitHub <noreply@github.com>2024-08-28 02:26:42 +0200
commit37452ee2db37441b2ee5e0abc99137687402be43 (patch)
treedb544b29c2cb74573c0f572765c2cb04691f15b0 /README.md
parentdafd7ab5cf649015c472dc548858632f66d36e99 (diff)
downloadNorthstarLauncher-37452ee2db37441b2ee5e0abc99137687402be43.tar.gz
NorthstarLauncher-37452ee2db37441b2ee5e0abc99137687402be43.zip
Document coding standards (#779)
Adds documentation explaining the coding standards to follow. Co-authored-by: F1F7Y <64418963+F1F7Y@users.noreply.github.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/README.md b/README.md
index 80be8fd0..64812201 100644
--- a/README.md
+++ b/README.md
@@ -9,4 +9,6 @@ Check [BUILD.md](BUILD.md) for instructions on how to compile, you can also down
## Format
+For project coding standards check out [STANDARDS.md](STANDARDS.md).
+
This project uses [clang-format](https://clang.llvm.org/docs/ClangFormat.html), make sure you run `clang-format -i --style=file --exclude=primedev/include primedev/*.cpp primedev/*.h` when opening a Pull Request. Check the tool's website for instructions on how to integrate it with your IDE.