Issue #519: Fix rendering the Readme

[nikosbosse]

Description

This PR closes #519

Rendering the Readme currently fails due to an untracked file README.html. This PR adds the file to the .gitignore file, hopefully resolving the issue.

Is there a way to test this change before merging?

Checklist

• My PR is based on a package issue and I have explicitly linked it.
• I have included the target issue or issues in the PR title as follows: issue-number: PR title
• I have tested my changes locally.
• I have added or updated unit tests where necessary.
• I have updated the documentation if required.
• I have built the package locally and run rebuilt docs using roxygen2.
• My code follows the established coding standards and I have run lintr::lint_package() to check for style issues introduced by my changes.
• I have added a news item linked to this PR.
• I have reviewed CI checks for this PR and addressed them as far as I am able.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (413d427) 90.92% compared to head (518af31) 90.92%.

❗ Current head 518af31 differs from pull request most recent head d3fb96e. Consider uploading reports for the commit d3fb96e to get more accurate results

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #526   +/-   ##
=======================================
  Coverage   90.92%   90.92%           
=======================================
  Files          23       23           
  Lines        1399     1399           
=======================================
  Hits         1272     1272           
  Misses        127      127           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[sbfnk]

Is there a way to test this change before merging?

Actions tab -> choose render readme in list on left -> Run workflow button -> select fix-render-readme branch -> run workflow

Seems to not warrant a version increment?

[seabbs]

Seems to not warrant a version increment?

Agree as this is just CI changes

It would need a dev version (i.e a 4th large number) if it were code related to prevent pkgdown updating and so people could delineate between what is on CRAN and main

[seabbs]

LGTM