Add project map diagrams to README.md

[alexkarezin]

PR Details

Description

Adding a link to the high-level diagrams including module, library dependency and others (https://sourcespy.com/github/usdotfhwastolcdasim/).

Built directly from source and updated on schedule. Intended to simplify developer's introduction to the project. In the spirit of transparency - I am the author of the diagrams.

Motivation and Context

This is an attempt to allow new contributors an easy way to explore repository structure, major components and dependencies.

How Has This Been Tested?

Documentation-only change.

Types of changes

• [ ] Defect fix (non-breaking change that fixes an issue)
• [ ] New feature (non-breaking change that adds functionality)
• [ ] Breaking change (fix or feature that cause existing functionality to change)

Checklist:

• [ ] I have added any new packages to the sonar-scanner.properties file
• [ ] My change requires a change to the documentation.
• [x] I have updated the documentation accordingly.
• [x] I have read the CONTRIBUTING document. CARMA Contributing Guide
• [ ] I have added tests to cover my changes.
• [x] All new and existing tests passed.

[alexkarezin]

Maybe Saikrishna could give it a quick look? This is a documentation-only change. Thank you in advance! @SaikrishnaBairamoni

[alexkarezin]

Maybe Saikrishna could give it a quick look? This is a documentation-only change. Thank you in advance! @SaikrishnaBairamoni

Can @SaikrishnaBairamoni or @kjrush review please. Thank you so much!

[SaikrishnaBairamoni]

Maybe Saikrishna could give it a quick look? This is a documentation-only change. Thank you in advance! @SaikrishnaBairamoni

Hello @alexkarezin Since kjrush is out we are waiting for him to review and get his inputs from his end, we will update you as soon as possible. Thanks!

[alexkarezin]

Hello @alexkarezin Since kjrush is out we are waiting for him to review and get his inputs from his end, we will update you as soon as possible. Thanks!

Thank you Saikrishna, much appreciated!

[paulbourelly999]

@alexkarezin @SaikrishnaBairamoni We are currently using doxygen for Code Documentation generation. We have not yet integration CDASim. Does this documentation serve some different purpose or provide some additional functionality no provided by Doxygen generated documentation?

[alexkarezin]

@paulbourelly999 @SaikrishnaBairamoni This documentation is expanding and visualizing complex dependencies within the application. The range/type of visualizations will grow and update automatically based on repository changes.

Currently, for example it illustrates individual module dependencies and per-module class hierarchies as part of overall class structure. Many others will be added.

The end goal is to provide contributors with an ability to zoom-in/zoom-out and go thru layers of the project to understand it's structure and contribute comfortably.