v15 - Install Refactor
Open
Nobody has claimed this yet.
v15
- Dominant language
- Python
- Stars
- 279
- Forks
- 177
- PR merge metrics
- No merged PRs in 30d
Description
Improve the install experience of py4DSTEM for users.
Clarify, simplify and update the install instructions on README.md.
- Work out which optional install methods are no longer needed.
- Determine what platforms and setups require different instructions.
- Clarify Anaconda and Pip install methods.
- Update the install instructions on
README.MD.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing README.md's current installation section and compare the Anaconda and pip instructions across the platforms and setups named in the issue. Identify optional methods that are no longer needed, then update README.md so the supported installation paths and platform-specific differences are clear.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- anaconda, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100