ndmitchell/shake

RFE: add a manpage for shake

Open

#106 geöffnet am 11. Apr. 2014

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Haskell (108 Forks)batch import
help wanted

Repository-Metriken

Stars
 (631 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

I know there is documention including a manual and --help output, but distros like Debian and Fedora like to have manpage for installed programs.

Is it possible to add a manpage shake (1) to the distribution? I think pandoc is able to generate them from markdown.

If the manpage could be generated from "shake --help" somehow perhaps it would be less work to keep in sync.

Contributor Guide

Research-Richtung
Untersuche den aktuellen Dokumentationserstellungsprozess (wahrscheinlich mit Make oder ähnlich) und identifiziere, wo ein Manpage Ziel hinzugefügt werden kann. Verwende pandoc, um die vorhandene Markdown Dokumentation in das Manpage Format zu konvertieren. Stelle sicher, dass die Manpage im Build System korrekt installiert wird.
Tech Stack
haskell
Domain
build system
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Haskellpandoc
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75