Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README with note about running on Windows #183

Merged
merged 3 commits into from
Jan 30, 2025

Conversation

m-goggins
Copy link
Collaborator

@m-goggins m-goggins commented Jan 28, 2025

Description

This PR adds a brief note about running the bootstrap script on a Windows machine. Due to how WSL can be configured on a Windows machine, users may wish to ignore the directory changing OR configure the repo in the Ubuntu directory of their machine in order for the script to run.

Related Issues

n/a

Additional Notes

RecordLinker had not been tested on a Windows machine

Copy link

codecov bot commented Jan 28, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.56%. Comparing base (9bd3778) to head (09d1801).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #183   +/-   ##
=======================================
  Coverage   97.56%   97.56%           
=======================================
  Files          31       31           
  Lines        1521     1521           
=======================================
  Hits         1484     1484           
  Misses         37       37           

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

@m-goggins m-goggins marked this pull request as ready for review January 28, 2025 22:55
README.md Outdated Show resolved Hide resolved
@m-goggins m-goggins requested a review from ericbuckley January 30, 2025 16:32
README.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@ericbuckley ericbuckley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for making our documentation better @m-goggins!

@m-goggins m-goggins merged commit 5bff4d1 into main Jan 30, 2025
15 checks passed
@m-goggins m-goggins deleted the marcelle/update-windows-docs branch January 30, 2025 16:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants