-
Notifications
You must be signed in to change notification settings - Fork 4
Open
Labels
basicdocumentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed
Description
Description:
Create a comprehensive installation troubleshooting guide for HyPyP that covers the three main operating systems and package managers.
Context:
New users often struggle with installation. We need clear, tested instructions that address common issues.
Tasks:
- Test installation on macOS (conda, pip, poetry)
- Test installation on Windows (conda, pip, poetry)
- Test installation on Linux/Ubuntu (conda, pip, poetry)
- Document common errors and their solutions
- Create a "quick checklist" for verifying successful installation
Acceptance Criteria:
- Guide covers macOS, Windows, and Linux
- Each OS section includes conda, pip, and poetry instructions
- At least 3 common errors per OS are documented with solutions
- A verification checklist confirms HyPyP imports correctly
- Tested by at least one person who didn't write it
Resources:
- Current README installation section
- HyPyP dependencies in
pyproject.toml
Metadata
Metadata
Assignees
Labels
basicdocumentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed