Skip to content

DOCS: Overhaul of all the DOCS in samples-python #69

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

V-Silpin
Copy link

This PR aims to enhance the readability and usability of the README.md files for each Python project. Currently, the documentation lacks clarity and does not adequately instruct users on the importance of using virtual environments when working with the sample projects.

Key Improvements

  1. Enhanced Readability
  2. Emphasis on Virtual Environments
  3. Step-by-Step Instructions

V-Silpin added 3 commits June 23, 2025 19:58
Signed-off-by: V-Silpin <varun.mohanta323@gmail.com>
Signed-off-by: V-Silpin <varun.mohanta323@gmail.com>
Signed-off-by: V-Silpin <varun.mohanta323@gmail.com>
```bash
python -m venv venv
```
2. Activating the Virtual Environment

Choose a reason for hiding this comment

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

This is actually a good suggestion to add the virtual environement

Copy link

@pratik-mahalle pratik-mahalle left a comment

Choose a reason for hiding this comment

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

Hi @V-Silpin Thank you for raising this pr.

@Achanandhi-M
Copy link
Contributor

Hey @V-Silpin Can you please updated the PR title?

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.

3 participants