luarocks / luarocks/luarocks

Add Unix manual page

Open
#1,483 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature request
Dominant language
Lua
Stars
3.7k
Forks
479
PR merge metrics
No merged PRs in 30d

Description

- **Description:**
- Luarocks should include a Unix manual page that has most information one would need to know about using the `luarocks` command-line utility. This could then be viewed on demand by running `man luarocks`.

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 by locating the files and packaging entry points that define the `luarocks` command-line utility and its installed documentation. Create a Unix manual page covering the information needed to use `luarocks`, and verify that it can be viewed on demand with `man luarocks`.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.