hyperium / hyperium/hyper

Cargo whines about not finding README.md

Open
#2,553 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
16.3k
Forks
1.8k
Avg merge
1d 22h
Merged PRs (30d)
14

Description

I got the following message from cargo recently:

error: failed to parse manifest at /build/hyper-0.13.8.crate/Cargo.toml

Caused by:
readme file with name 'README.md' was not found

It seems cargo enforces that a readme file exists if it is included in Cargo.toml.

Obviously, hyper has a README.md file.
It is just not included in the crate downloaded from crates.io.

Weirdly, of the crates I have checked, this only seems to apply the hyper crate.

Any idea ?

Contributor guide

Open the contributing guide

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

Inspect Cargo.toml and the published crate contents for hyper 0.13.8, starting by reproducing Cargo's missing README.md error. Confirm why README.md is omitted from the crate and make the packaging and manifest agree; done when the crate parses successfully with Cargo.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.