From d25507c39a9c08ee428c95121167ae994aaf825d Mon Sep 17 00:00:00 2001 From: jantoun-scottlogic Date: Thu, 2 May 2024 09:54:31 +0100 Subject: [PATCH] Update line endings section of README --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 764a54e8..e73c0efe 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,11 @@ The tech carbon estimator is a web component that allow you to estimate, at high ## Using component exposed as a web component `tech-carbon-estimator`. The component takes the follow optional input: + - `extra-height` - this is extra height to be added whe calculating the height if the chart. eg a header/footer that will be visible on the page You will need to import the following files to use the tech-carbon-estimator: + - main.js - polyfill.js - styles.css @@ -42,6 +44,14 @@ This project is configured to use Linux/macOS line endings (Line Feed or LF), wh git config core.autocrlf input ``` +This option can also be set when cloning the repository by running: + +``` +git clone REPOSITORY_URL --config core.autocrlf=input +``` + +Applying the setting when cloning rather than after cloning may help resolve issues related to line endings when setting up the project in VSCode. + ## Documentation For further documentation please see the [docs](docs) folder.