spesmilo / spesmilo/electrum

Provide a Man Page

Open
#994 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement ✨
Dominant language
Python
Stars
8.6k
Forks
3.5k
Avg merge
2d 8h
Merged PRs (30d)
61

Description

To package your software in linux it helps to provide a Man page, as it is the common way in Linux to get help. See here

The debian project already provides a man file for their package, perhaps it could be used and managed upstream?
It is in the electrum_version.debian.tar.gz file found here, and one is allowed to reuse it as stated in the package.

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 reviewing the Debian man file in electrum_version.debian.tar.gz and the linked packaging guidelines. Determine how that file could be managed upstream; the work is done when the project provides an upstream man page suitable for Linux packaging.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.