Maybe unify install instructions in README and on website
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8.6k
- Forks
- 3.5k
- Avg merge
- 2d 8h
- Merged PRs (30d)
- 61
Description
A significant portion of the current README is comprised of installation instructions.
Similarly, there are install instructions on the website.
- Maybe we could move the install steps from the README to a separate file that we could link to from the README (perhaps give a TL;DR in the README).
- Maybe we could link from the website to this new install instructions file in the repository.
Note that the instructions on the website are concerned with the latest release while the README atm is obviously about HEAD. In the future, from the website, we could link to the instructions at a specific tag/commit.
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
Compare the installation instructions in README.rst with those on the website at electrum.org/#download, paying attention to the distinction between HEAD and the latest release. Decide how the instructions should be shared or linked, and consider how version-specific links would work; done means the README and website no longer duplicate conflicting installation guidance.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100