Skip to content

Commit

Permalink
Merge pull request #53 from ScottLogic/update-line-endings-section-in…
Browse files Browse the repository at this point in the history
…-readme

Update line endings section of README
  • Loading branch information
jantoun-scottlogic authored May 2, 2024
2 parents 11da05d + d25507c commit 2cdc6cf
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit 2cdc6cf

Please sign in to comment.