Updated readme with updated file structure

[nileshaher-2024si96522]

Updated README.md to reflect the latest project structure.

• Added an overview of the new directory hierarchy.
• Included explanations for key folders and files.
• Improved formatting for better readability and navigation.

Summary by Sourcery

Documentation:

• Replace the outdated library file structure image in the README with an updated diagram reflecting the current project layout.

[sourcery-ai]

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates the README’s library file structure illustration to use a new, embedded image reference that reflects the latest project layout.

File-Level Changes

Change	Details	Files
Replaced the outdated library file structure image in the README with an updated image reference and HTML-based embed.	Updated the markdown image line under the library file structure section to point to the new GitHub user-attachments asset. Switched from a simple markdown image syntax to an HTML-style tag to control width, height, and alt text for the library layout illustration.	README.md

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey - I've found 1 issue, and left some high level feedback:

• The updated README image link mixes Markdown and HTML (![... ]<img ... />); choose a single format (Markdown or <img> alone) so the image renders correctly.
• If you stick with the <img> tag, consider keeping the previous descriptive alt text (e.g., alt="Library File Structure") for accessibility and consistency with the prior README.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- The updated README image link mixes Markdown and HTML (`![... ]<img ... />`); choose a single format (Markdown or `<img>` alone) so the image renders correctly.
- If you stick with the `<img>` tag, consider keeping the previous descriptive alt text (e.g., `alt="Library File Structure"`) for accessibility and consistency with the prior README.

## Individual Comments

### Comment 1
<location> `README.md:103` </location>
<code_context>
 <br>

-![Library File Structure](https://github.com/extinctsion/easyPythonpi/assets/67048929/f772ba66-e2eb-4e42-b1b7-104facf6eda4)
+![Library File Structure]<img width="1800" height="1400" alt="easyPythonpi_package_layout_final" src="https://github.com/user-attachments/assets/f5a42d57-0385-4ffe-b9e5-0fd1e80a168a" />

 <br>
</code_context>

<issue_to_address>
**issue:** The combined Markdown and HTML image syntax here is likely malformed and may not render as intended.

This combines Markdown (`![Library File Structure]`) with an HTML `<img>` tag in a way most renderers won’t treat as a valid image, so the alt text may show up literally. Please use either a proper Markdown image with URL, or a standalone HTML `<img>` tag, but not both together on the same line.
</issue_to_address>

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[nileshaher-2024si96522]

hi @extinctsion , please review!

[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 SonarQube Cloud

[nileshaher-2024si96522]

hi @extinctsion , please review!

[extinctsion]

Sure. Please give me some time as I'm a bit busy with other work. I'll surely review the PR.

[extinctsion]

looks good