Modifications to Improve Readability and Navigation of README.md File

dyannya commented 1 year ago

Summary of change

Updated readme file by adding table of contents, visual instructions (i.e. terminal navigation), skimmable formatting, and broken links.

Closes #991

Please keep this checklist in & ensure you have done the following:

[x] Read, understood and adhered to our contributing document.
- [ ] Ensure that you were first assigned to a relevant issue before creating this pull request
- [x] Ensure code changes pass all tests
[x] Read, understood and adhered to our style guide. A lot of our code reviews are spent on ensuring compliance with our style guide, so it would save a lot of time if this was adhered to from the outset.
[x] Filled in the summary, context (if applicable) and related issue section. Replace the square brackets and its placeholder content with your contents. For an example, see any merged in pull request
[x] Set this pull request to 'draft' if you are still working on it
[x] Resolved any merge conflicts

For any of the optional checkboxes (e.g. the screenshots one), still check it if it does not apply.

guide-bot[bot] commented 1 year ago

Thanks for opening this Pull Request! We need you to:

Complete the activities.

Action: Complete Ensure that you were first assigned to a relevant issue before creating this pull request

If an activity is not applicable, use '\~activity description\~' to mark it not applicable.

knjk04 commented 1 year ago

Hi @dyannya, thanks so much for creating this PR and for the effort you put in.

Unfortunately, I will be archiving this project as I no longer have the time to maintain it. I will close this pull request, but thanks again!