Author: Max Jakobitsch <minigugler@gmail.com>
docs: add git config items to docs
doc/buildAndProgram.md | 7 ++++++- doc/buildWithDocker.md | 6 +++++-
diff --git a/doc/buildAndProgram.md b/doc/buildAndProgram.md index b588b649f212ed890eb063ba7ce0bce0b2de1d7c..8aa32dafeb7d9e751f1c3bebf50f9dd4b7f60975 100644 --- a/doc/buildAndProgram.md +++ b/doc/buildAndProgram.md @@ -24,10 +24,15 @@ ## Build steps ### 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 670590a6455d44aeb1b6c650d9a4e24d9d99d54c..9ad65fec90e13e2590781abab4db23ba76d65d20 100644 --- a/doc/buildWithDocker.md +++ b/doc/buildWithDocker.md @@ -15,10 +15,14 @@ ## Clone the repository 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