Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add images in the required place in README.md #1

Open
pruthviraj-desale opened this issue Sep 27, 2024 · 0 comments
Open

Add images in the required place in README.md #1

pruthviraj-desale opened this issue Sep 27, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@pruthviraj-desale
Copy link
Collaborator

The README.md file for this project currently has placeholder comments () where relevant images need to be inserted. These images will help improve the visual appeal and clarity of the project documentation, making it easier for contributors and users to understand the setup and functionality of the project.

Tasks:

  • Identify the sections in the README.md where the placeholders for images are present.
  • Add appropriate images that represent each section (e.g., screenshots, diagrams, or relevant visuals).
  • Ensure the images are clear and relevant to the context of the content.
  • Make sure the images are hosted on a reliable platform (e.g., GitHub, Imgur) or included in the repository if appropriate.

Instructions:

  1. Create a new branch named add-images-readme.
  2. Add the images in the necessary sections of the README.md.

Notes:

  • Make sure the images are of high quality.
  • Ensure the file paths for the images are correct, especially if adding them directly to the repository.
  • Feel free to ask questions if you need clarification on what images to use.
@pruthviraj-desale pruthviraj-desale added documentation Improvements or additions to documentation good first issue Good for newcomers labels Sep 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant