mimblewimble/grin

Clear Build and Install Instructions for each Major OS

Open

#2559 opened on Feb 11, 2019

View on GitHub
 (9 comments) (0 reactions) (0 assignees)Rust (4,876 stars) (991 forks)batch import
good first issuetask

Description

The document: https://github.com/mimblewimble/grin/blob/master/doc/build.md

Needs Signifant Overview.

Installing on MacOS is as simple as:

Contributor guide

Tech stack
rust
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
Basic knowledge of RustFamiliarity with command line
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Review the current build.md file at https://github.com/mimblewimble/grin/blob/master/doc/build.md and identify missing or unclear instructions for each major OS (Linux, macOS, Windows). The issue suggests macOS steps are simple; verify and expand on Linux and Windows setups. Check comments for any OS specific issues or updates. Update the document with clear, tested instructions, including prerequisites like installing Rust via rustup and cloning the repo.