webtorrent/webtorrent-desktop

Create INSTALL.md for detailed install instructions

Open

#1,706 opened on Sep 19, 2019

View on GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (1,055 forks)batch import
acceptedarea/uxenhancementhelp wantedplatform/linuxplatform/macplatform/windows

Repository metrics

Stars
 (9,423 stars)
PR merge metrics
 (Avg merge 1m) (5 merged PRs in 30d)

Description

I think we should create an INSTALL.md file in the root of this repo with detailed installation instructions for each OS, including our recommended installation method, as well as alternatives.

For Mac, for example, we recommend the official installer on the website, but it's also available via a Homebrew Cask.

For each Linux variant, there will be a different command or preferred file to use.

Does someone want to take a stab at an initial version of this document? We can also link to it from the WebTorrent Desktop homepage, near all the download links.

Contributor guide

Research direction
Review the existing WebTorrent Desktop homepage for download links and read the project's README to understand current installation methods. Compile the installation instructions per OS and create INSTALL.md file.
Tech stack
javascript
Domain
desktop
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90