Skip to content

Update README.md#5

Merged
PttCodingMan merged 1 commit intomainfrom
update-readme-for-venv
Jul 8, 2025
Merged

Update README.md#5
PttCodingMan merged 1 commit intomainfrom
update-readme-for-venv

Conversation

@PichuChen
Copy link
Collaborator

增加 venv 相關的步驟,減少新手會遇到的障礙

增加 venv 相關的步驟,減少新手會遇到的障礙
Copilot AI review requested due to automatic review settings July 8, 2025 02:49
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR enhances the Quick Start section of README.md by adding virtual environment (venv) setup steps to lower the barrier for new users.

  • Adds venv creation and activation commands before installing the package
  • Includes a note for reactivating the venv on subsequent uses
Comments suppressed due to low confidence (1)

README.md:35

  • Consider adding instructions to deactivate the virtual environment (e.g., deactivate) after use to help new users close the session properly.
    * 第二次使用的時候從 `source venv/bin/activate` 就可以了😊

1. **安裝套件:**
1. **安裝套件(使用venv):**
```bash
python3 -m venv venv
Copy link

Copilot AI Jul 8, 2025

Choose a reason for hiding this comment

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

It may be helpful to remind users to add the venv/ directory to .gitignore to avoid committing the virtual environment to the repository.

Copilot uses AI. Check for mistakes.
@PichuChen PichuChen requested a review from PttCodingMan July 8, 2025 04:56
Copy link
Member

@PttCodingMan PttCodingMan left a comment

Choose a reason for hiding this comment

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

LGTM.

@PttCodingMan PttCodingMan merged commit 8a674eb into main Jul 8, 2025
1 check passed
@PttCodingMan PttCodingMan deleted the update-readme-for-venv branch July 9, 2025 03:16
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