Skip to content

Commit 4066cc0

Browse files
committed
docs: add git config items to docs
1 parent 99298b5 commit 4066cc0

File tree

2 files changed

+11
-2
lines changed

2 files changed

+11
-2
lines changed

doc/buildAndProgram.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,15 @@ To build this project, you'll need:
2424
2525
### Clone the repo
2626
27-
```
27+
```sh
2828
git clone https://github.com/InfiniTimeOrg/InfiniTime.git
2929
cd InfiniTime
3030
git submodule update --init
31+
32+
# configure git to apply whitespace fixes automatically
33+
git config set core.whitespace trailing-space,space-before-tab
34+
git config set apply.whitespace fix
35+
3136
mkdir build
3237
cd build
3338
```

doc/buildWithDocker.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,14 @@ Based on Ubuntu 22.04 with the following build dependencies:
1515

1616
Before building, local repository must be fully initialized.
1717

18-
```
18+
```sh
1919
git clone https://github.com/InfiniTimeOrg/InfiniTime.git
2020
cd InfiniTime
2121
git submodule update --init
22+
23+
# configure git to apply whitespace fixes automatically
24+
git config set core.whitespace trailing-space,space-before-tab
25+
git config set apply.whitespace fix
2226
```
2327

2428
## Run a container to build the project

0 commit comments

Comments
 (0)