Please include build dependencies in build instructions

Open Beginner friendly
#347 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
rust
Domain
build-system, documentation

Research direction

Start with README.md and review the existing build instructions for authenticator-rs. Document the required Debian packages: libudev-dev, mercurial, gyp, and ninja-build. Done means users can identify and install these build dependencies before building without relying on missing-package error messages.

Written by the indexing model from the issue text.

Description

Building authenticator-rs requires installing several other packages such as libudev-dev, mercurial, gyp and ninja-build (package names from Debian).

It's not easy to understand from the error messages when these packages are missing. It would be great if the necessary build dependencies could be explicitly mentioned in the README.md so that users don't have to waste their time with try-and-error.

Dominant language
Rust
Stars
316
Forks
82
Avg merge
4d 20h
Merged PRs (30d)
1

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from mozilla/authenticator-rs

All issues in mozilla/authenticator-rs

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.