-
Notifications
You must be signed in to change notification settings - Fork 497
Update README: add Python backend setup with proper code blocks #893
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
base: main
Are you sure you want to change the base?
Conversation
|
|
📝 WalkthroughWalkthroughThe pull request adds a "Backend Setup (Python)" section to README.md that specifies Python 3.11.x, shows how to create/activate a virtual environment (Windows Git Bash example), install dependencies from Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
Pre-merge checks✅ Passed checks (3 passed)
📜 Recent review detailsConfiguration used: defaults Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
|
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.
Actionable comments posted: 1
🧹 Nitpick comments (1)
README.md (1)
19-37: Add platform-specific instructions for macOS and Linux.The setup instructions are currently limited to Windows (Git Bash). Since PictoPy is marketed as cross-platform, contributors on macOS and Linux will need equivalent instructions. Consider adding branches for each platform, or clarifying if setup differs across platforms.
🔎 Example structure for multi-platform instructions
### 1. Create and activate a virtual environment **Windows (Git Bash):** \`\`\`bash python -m venv venv source venv/Scripts/activate \`\`\` **macOS and Linux:** \`\`\`bash python3 -m venv venv source venv/bin/activate \`\`\`This ensures users on all platforms have clear, actionable guidance.
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md
🔇 Additional comments (1)
README.md (1)
12-37: Backend setup documentation is a valuable addition.The new "Backend Setup (Python)" section provides clear, step-by-step guidance with proper code block formatting and appropriate version constraints. This will help reduce setup friction for new contributors. Once the minor formatting issue and platform coverage are addressed, this section will be solid.
|
Hi maintainers , Please let me know if any changes or improvements are needed. |
|
|
1 similar comment
|
|
This PR updates the README.md to include clear instructions for setting up the Python backend for PictoPy.
Changes include:
This should help new contributors get the backend running smoothly and reduce setup confusion.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.