From 483435ae3db9ab5fa3fa8876e941770fa0f878f4 Mon Sep 17 00:00:00 2001 From: Max Jakobitsch Date: Wed, 12 Feb 2025 09:00:51 +0100 Subject: [PATCH] docs: add git config items to docs --- doc/buildAndProgram.md | 7 ++++++- doc/buildWithDocker.md | 6 +++++- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/doc/buildAndProgram.md b/doc/buildAndProgram.md index b588b649..8aa32daf 100644 --- a/doc/buildAndProgram.md +++ b/doc/buildAndProgram.md @@ -24,10 +24,15 @@ To build this project, you'll need: ### Clone the repo -``` +```sh git clone https://github.com/InfiniTimeOrg/InfiniTime.git cd InfiniTime git submodule update --init + +# configure git to apply whitespace fixes automatically +git config set core.whitespace trailing-space,space-before-tab +git config set apply.whitespace fix + mkdir build cd build ``` diff --git a/doc/buildWithDocker.md b/doc/buildWithDocker.md index 670590a6..9ad65fec 100644 --- a/doc/buildWithDocker.md +++ b/doc/buildWithDocker.md @@ -15,10 +15,14 @@ Based on Ubuntu 22.04 with the following build dependencies: Before building, local repository must be fully initialized. -``` +```sh git clone https://github.com/InfiniTimeOrg/InfiniTime.git cd InfiniTime git submodule update --init + +# configure git to apply whitespace fixes automatically +git config set core.whitespace trailing-space,space-before-tab +git config set apply.whitespace fix ``` ## Run a container to build the project