Skip to content

Updated README.md File for Communication Module#40

Closed
Tejveerpratap2803 wants to merge 6 commits intoeclipse-score:mainfrom
Tejveerpratap2803:updated-readme
Closed

Updated README.md File for Communication Module#40
Tejveerpratap2803 wants to merge 6 commits intoeclipse-score:mainfrom
Tejveerpratap2803:updated-readme

Conversation

@Tejveerpratap2803
Copy link
Contributor

  • Updated the Readme.md file for communication module.
  • Added detailed sections including Overview, Architecture, System Flow Diagram, Features, Build Instructions, Project Structure, Testing, Documentation, and Contribution Guidelines to improve clarity.

Copy link
Contributor

@lurtz lurtz left a comment

Choose a reason for hiding this comment

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

I would love more sentences and less bullet points. I see also redundancy to other documents we already have and we should try to avoid duplication, because that will eventually create more work to keep it in sync.

@Tejveerpratap2803
Copy link
Contributor Author

  • Moved contribution steps to CONTRIBUTING.md
  • Added ECA requirement and build/test instructions.
  • Updated README and included SVG flow diagram for intra-ECU communication.

@Tejveerpratap2803 Tejveerpratap2803 marked this pull request as draft August 3, 2025 17:47
@lurtz
Copy link
Contributor

lurtz commented Aug 4, 2025

I do not know why, but I cannot resolve any of my findings

@Tejveerpratap2803 Tejveerpratap2803 requested a review from lurtz August 6, 2025 14:55
@Tejveerpratap2803 Tejveerpratap2803 marked this pull request as ready for review August 6, 2025 14:56
@Tejveerpratap2803 Tejveerpratap2803 marked this pull request as draft August 6, 2025 14:57
@Tejveerpratap2803 Tejveerpratap2803 deleted the updated-readme branch August 14, 2025 14:29
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.

4 participants