Skip to content

Conversation

DHANUSHRAJA22
Copy link

Description

Resolves issue #557 by fixing the virtual environment activation command for Linux systems in the installation documentation.

Changes made:

  • Changed ./venv/bin/activate to source ./venv/bin/activate
  • Added a Linux note explaining that the activate script typically doesn't have execution permissions and must be sourced

This ensures that the documentation provides the correct command for activating virtual environments on Linux systems.

What type of PR is this?

  • 🐛 Bug Fix
  • 📝 Documentation Update

Added/updated tests?

  • 🙅 no, because they aren't needed (documentation only change)

Related PRs, Issues etc

Checklist

  • Ran the Black Formatter and
    djLint-er on any new code
  • Made any changes or additions to the documentation where required
  • Changes generate no new warnings/errors
  • New and existing unit tests pass locally with my
    changes

What type of PR is this?

  • ✨ Feature
  • 🐛 Bug Fix
  • 🚨 Breaking Change
  • ♻️ Code Refactor
  • 📝 Documentation Update

Added/updated tests?

  • 👍 yes
  • 🙅 no, because they aren't needed
  • 🙋 no, because I need help

Related PRs, Issues etc

  • Related Issue #
  • Closes #

…modernize README with improved design and concise contentUpdate README.md

- Restructured README for better readability and visual appeal
- Added modern badges and centered header layout
- Created feature table for better organization
- Condensed contributing guidelines while keeping essential info
- Added emoji icons for better visual hierarchy
- Improved installation instructions with code examples
- Added security section and contributor recognition
- Streamlined content to be more concise and to-the-point

Addresses issue TreyWW#488: revamp of readme
…: update venv activation command for Linux systems (TreyWW#557)Update installation.md

Resolves issue TreyWW#557 by fixing the virtual environment activation command for Linux systems.

Changes made:
- Changed `./venv/bin/activate` to `source ./venv/bin/activate`
- Added a Linux note explaining that the activate script typically doesn't have execution permissions and must be sourced

This ensures that the documentation provides the correct command for activating virtual environments on Linux systems.
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.

bug: in documentation venv has to be sourced
1 participant