diff --git a/README.md b/README.md index 077e767357..648862bcfd 100644 --- a/README.md +++ b/README.md @@ -42,9 +42,25 @@ Download and build the latest main of `elastic-package` binary: ```bash git clone https://github.com/elastic/elastic-package.git +cd elastic-package make build ``` +When developing on Windows, please use the `core.autocrlf=input` or `core.autocrlf=false` option to avoid issues with CRLF line endings: +```bash +git clone --config core.autocrlf=input https://github.com/elastic/elastic-package.git +cd elastic-package +make build +``` + +This option can be also configured on existing clones with the following commands. Be aware that these commands +will remove uncommited changes. +```bash +git config core.autocrlf input +git rm --cached -r . +git reset --hard +``` + ## Commands `elastic-package` currently offers the commands listed below. diff --git a/tools/readme/readme.md.tmpl b/tools/readme/readme.md.tmpl index 16e17dbfc3..3e83a39f1b 100644 --- a/tools/readme/readme.md.tmpl +++ b/tools/readme/readme.md.tmpl @@ -42,9 +42,25 @@ Download and build the latest main of `elastic-package` binary: ```bash git clone https://github.com/elastic/elastic-package.git +cd elastic-package make build ``` +When developing on Windows, please use the `core.autocrlf=input` or `core.autocrlf=false` option to avoid issues with CRLF line endings: +```bash +git clone --config core.autocrlf=input https://github.com/elastic/elastic-package.git +cd elastic-package +make build +``` + +This option can be also configured on existing clones with the following commands. Be aware that these commands +will remove uncommited changes. +```bash +git config core.autocrlf input +git rm --cached -r . +git reset --hard +``` + ## Commands `elastic-package` currently offers the commands listed below.