oxidecomputer / oxidecomputer/humility

humlity could use build and pre-req instructions

Open
#55 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
584
Forks
63
Avg merge
3h
Merged PRs (30d)
2

Description

After spending time with hubris, it may catch you off guard that you can build without using xtask. It'd help to call this out explicitly. I know there are requirements that systems don't have by default which we need, which I've listed below. I'm not sure what the full set is because I'm not starting from say an empty install:

  • libusb1 (note this is not the same libusb gets pulled in as an automatic dep on many systems with libftdi1)
  • libftdi1

At least starting with these two things might help folks. I suspect there are more here, but I'm hitting other issues I need to debug.

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.

Research direction

No documentation file is named in the issue. Start by inspecting the repository's existing build instructions and the xtask entry point, then verify the listed libusb1 and libftdi1 prerequisites on a clean or minimal system. Done means the documented build path and required packages are explicit, including whether xtask is needed.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
build-system, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
40/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.