The readme was out of sync with the developments made in the dev-environment. This PR aims to rectify that and improve other information and configuration in various places to give new contributors a better experience when starting and setting up the project
Issue
This PR addresses issue #166 .
Contribution Checklist:
[x] The pull request only addresses one issue or adds one feature.
[x] The pull request does not introduce any breaking changes
[ ] I have added screenshots or gifs to help explain the change if applicable.
[x] I have ran the linting and formatting scripts to make sure the code is consistently styled.
[x] I have built/compiled and ran the tests to make sure the code works correctly.
[x] I have added or changed tests to cover new or different functionality, where applicable.
[x] Create an issue and link to the pull request.
Note: Keeping the PR small and focused helps make it easier to review and merge. If you have multiple changes you want to make, please consider submitting them as separate pull requests.
Description
The readme was out of sync with the developments made in the dev-environment. This PR aims to rectify that and improve other information and configuration in various places to give new contributors a better experience when starting and setting up the project
Issue
This PR addresses issue #166 .
Contribution Checklist:
Note: Keeping the PR small and focused helps make it easier to review and merge. If you have multiple changes you want to make, please consider submitting them as separate pull requests.