aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBarichello <artur@barichello.me>2022-02-15 00:54:14 -0300
committerBarichello <artur@barichello.me>2022-02-15 00:54:14 -0300
commitc160ef24545404998869fa07a8c8a818fb521c35 (patch)
tree55e965980425081f5db10585fbbdef0ed93e0008 /README.md
parent5a480af7d3a51d0c6fface4097fbe7261e62f803 (diff)
downloadNorthstarLauncher-c160ef24545404998869fa07a8c8a818fb521c35.tar.gz
NorthstarLauncher-c160ef24545404998869fa07a8c8a818fb521c35.zip
Add format section
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/README.md b/README.md
index 97d6f97d..855969e2 100644
--- a/README.md
+++ b/README.md
@@ -6,3 +6,7 @@ Launcher used to modify Titanfall 2 to allow Northstar mods and custom content t
## Build
Check [BUILD.md](https://github.com/R2Northstar/NorthstarLauncher/blob/main/BUILD.md) for instructions on how to compile, you can also download [binaries built by GitHub Actions](https://github.com/R2Northstar/NorthstarLauncher/actions).
+
+## Format
+
+This project uses [clang-format](https://clang.llvm.org/docs/ClangFormat.html), make sure you run `clang-format -i --style=file LauncherInjector/*.cpp LauncherInjector/*.h NorthstarDedicatedTest/*.cpp NorthstarDedicatedTest/*.h` when opening a Pull Request. Check the tool's website for instructions on how to integrate it with your IDE.