From 3a4629b264f04194a2477c8ff8c9d3e85b45f9f3 Mon Sep 17 00:00:00 2001 From: Stijn de Witt Date: Mon, 31 Oct 2016 12:32:54 +0100 Subject: [PATCH] Add a paragraph to the `Gotchas` section that warns about `core.autocrlf` --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 34ee559..e26702c 100644 --- a/README.md +++ b/README.md @@ -295,6 +295,16 @@ return (this.props.isAuthorized ? **NOTE:** in a subsequent release of react-i18nliner, the former example will cause an `i18nliner:check` failure. You've been warned :) +### Cloning this project under Windows + +This project's eslint settings force a check on the use of linefeed characters +that will fail when the project is cloned with the git +[core.autocrlf](https://git-scm.com/book/tr/v2/Customizing-Git-Git-Configuration) +setting set to `true`, which is the default on Windows. So make sure to change +that setting beforehand. The easiest way to do this is probably to `git init` a new +repo for this project and change the setting, and only then add this repo as a +remote and pull from it. + ## Related Projects * [i18nliner (ruby)](https://github.com/jenseng/i18nliner)