[FDS-2218] Update the README

[jaymedina]

problem

The README.md needed to be updated for clarity in certain parts, particularly the installation instructions and use-case examples.

solution

• Overall re-structure and stylistic changes
• Add a TL;DR section to provide a quick summary of schematic and its uses
• Improve developer setup and contribution instructions

Items from Jira tickets:

• Update development environment instructions for a wider audience: ticket
• Consolidate installation instructions between Confluence and GitHub: ticket
• Point readers to service desk for help: ticket
• Fix hyperlink in Testing section: ticket
• Fix CLI reference link: ticket

testing

N/A

[BryanFauble]

This is great! Amazing usage of formatting using the note, important, and warning block!

[BryanFauble]

1 comment on a dead link, otherwise LGTM!

[GiaJordan]

@jaymedina thank you so much for your effort on this! I just left a couple of small comments/questions.

[thomasyu888]

🔥 LGTM!

[GiaJordan]

@jaymedina thanks for making those changes!
When I was looking through the README file though it looks like the section links from Contribution Guidelines through Reporting Bugs or feature requests don't lead anywhere now?

[jaymedina]

@GiaJordan you're right, that's because I moved those sections out of the README and into CONTRIBUTING - I'll go ahead and remove them from the table of contents. Thanks for the catch!

[GiaJordan]

@jaymedina that makes sense, thanks!

[GiaJordan]

Thanks again @jaymedina ! approving before tests finish as changes are constrained to the md doc files

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud