n0-computer / n0-computer/sendme

README does not mention other installation methods

Open
#77 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
1.2k
Forks
78
PR merge metrics
No merged PRs in 30d

Description

I was linked the webpage for sendme by a friend. (I presume this is an official site because it's hosted on iroh.computer, which the iroh repository under the same GitHub organization links to). This site contains an install script at https://iroh.computer/sendme.sh. Reading the script, it downloads the blobs on this repository's releases. However, the README on this repository suggests using cargo install.

Could the install script (and page, maybe?) be added to the README? When showing sendme to a friend, they missed the Releases tab and just assumed they had to compile from source. My servers usually don't have Rust installed on them, and when they do I don't want to be compiling binaries. If I didn't know about the install script/releases I would've just not used sendme!

Also, it'd be nice to have a link to the releases on the README and site (https://github.com/n0-computer/sendme/releases/latest). I tend to use file sharing programs with people who don't often work with the command line (especially people on Windows). I don't want to potentially scare them off by thinking they have to compile it from source, or them trying the curl | sh on a Windows machine and it not working.

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

Start with the README section that currently recommends cargo install, then review the linked sendme.sh installer and the latest releases URL. Done means the README clearly points to the install script and releases, with the site update considered if its source is available.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.