n0-computer / n0-computer/sendme
Provide more install options on website
Open
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 1.2k
- Forks
- 78
- PR merge metrics
- No merged PRs in 30d
Description
The website only shows an opaque script to install with no explanation what it does.
- There should be a description of what the script will do.
- There should be a
--helpoutput to the script including this description. - There should be a direct link to the github releases page on the install instructions
- When you find the readme (which you will once there is a link to the github releaes) the readme deescribes
cargo install. Which is great! It should probably also point to the releases page and maybe even the curl install script.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the website's install instructions, the install script's --help output, and the README's cargo install section. Document what the script does, expose that description through --help, link to GitHub releases, and cross-link the README's installation options.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100