webtorrent/webtorrent-desktop

Create INSTALL.md for detailed install instructions

Open

#1706 opened on Sep 19, 2019

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

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

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
MarkdownBasic understanding of OS specific installation methods
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Create a new file `INSTALL.md` in the root of the repository. Include step by step instructions for Windows, macOS, and Linux, covering the recommended official installer and alternative methods like Homebrew for macOS and package managers for various Linux distributions. Reference any existing download links from the WebTorrent Desktop homepage.