mention shell completions usage in `README.md`
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 16.2k
- Forks
- 510
- PR merge metrics
- No merged PRs in 30d
Description
https://github.com/lsd-rs/lsd/blob/2fe3fcdd3564836962eab8ba6b1444996fe24e1e/build.rs#L24-L36
despite lsd providing shell completions via [`clap_complete::generate_to`](https://docs.rs/clap_complete/latest/clap_complete/generator/fn.generate_to.html), there is no documentation that either `SHELL_COMPLETIONS_DIR` or `OUT_DIR` environment variable needs to be set to generate one.
alternatively, LSD could provide a command-line option to generate completions at runtime.
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 README.md and compare its shell-completion guidance with build.rs lines 24-36. Document that SHELL_COMPLETIONS_DIR or OUT_DIR must be set when generating completions, and clarify the expected usage; the README should explain this without requiring the alternative runtime command-line feature.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100