docs: clarify venv usage and add post-installation verification. #138
+54
−6
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related Issue / Discussion:
Fixes Issue #114
Changes:
Please list the central functionalities that have been changed:
Further Details:
Summary:
The current installation documentation is technically accurate but lacks context for new contributors who may not be familiar with virtual environments. Additionally, there was no clear "first-run" guidance to verify a successful setup on Windows.
Before: The guide provided commands for environment setup without explaining their purpose or how to verify the tool was functioning correctly afterward.
After: Added a brief explanation of why venv is recommended and a "What to do after installation" section that guides users to run the sandbox example and check their PYTHONPATH.
Dependencies:
No new dependencies are required for this documentation update.
PR Checklist:
In the context of this PR, I: