-
Notifications
You must be signed in to change notification settings - Fork 14
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
README
: update installation instructions to build PySolid from source
#102
README
: update installation instructions to build PySolid from source
#102
Conversation
Change pip command to use the local PySolid repository when installing the cloned repository. Fix export command of python path.
Reviewer's Guide by SourceryThis pull request modifies the installation instructions in the README.md file to correctly build PySolid from the source code. It updates the pip install commands to reference the local PySolid repository and fixes the PYTHONPATH export command to point to the correct source directory. No diagrams generated as the changes look simple and do not need a visual representation. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
PR summaryThis Pull Request updates the installation instructions in the SuggestionTo further enhance the clarity of the installation instructions, consider adding a brief explanation or example of what This comment was generated by AI. Information provided may be incorrect. Current plan usage: 0% Have feedback or need help? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @AndreHauschild - I've reviewed your changes - here's some feedback:
Overall Comments:
- The instructions for manually compiling the Fortran code could be improved by providing more specific guidance on setting the PYTHONPATH.
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Thank you @AndreHauschild for the update!
README
: update installation instructions to build PySolid from source
Change pip command to use the local PySolid repository when installing the cloned repository. Fix export command of python path.
Summary by Sourcery
Fixes the installation instructions in the README to correctly build PySolid from source, updating the
pip install
command to use the local PySolid repository and correcting the path in theexport
command.Bug Fixes:
pip install
command now uses the local PySolid repository, and theexport
command now includes the correct path to the PySolid main folder.Documentation: