diff options
| author | Max Jakobitsch <minigugler@gmail.com> | 2025-02-12 09:00:51 +0100 |
|---|---|---|
| committer | JF <JF002@users.noreply.github.com> | 2025-03-21 17:36:47 +0100 |
| commit | 483435ae3db9ab5fa3fa8876e941770fa0f878f4 (patch) | |
| tree | 5639fad6a6d559b862e521d28016483bb008fb99 | |
| parent | 3659e9a4bafdf4f7a5fe241cc38b82f2a469b38b (diff) | |
docs: add git config items to docs
| -rw-r--r-- | doc/buildAndProgram.md | 7 | ||||
| -rw-r--r-- | 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 |