From 7c6198e48b1810d67e6b11031cf7dbe86300f818 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9E=97=E5=8D=9A=E4=BB=81?= Date: Thu, 15 Jun 2017 16:16:26 +0800 Subject: [PATCH] Move help on writing manpages to Contributing Guide MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: 林博仁 --- CONTRIBUTING.md | 9 +++++++++ src/woeusb.1 | 2 -- src/woeusbgui.1 | 2 -- 3 files changed, 9 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9ce097c..a09981d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,6 +12,15 @@ Use keywords instead of full sentences as search query, for example search "cras ### Report Software Bugs Effectively How you report software bugs greatly effects how fast it has been processed and fixed, refer [How to Report Bugs Effectively](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html) for more information +## Improving Documentation +The documentation of this project may be outdated through time, and needs help to make it updated. + +### Manual Pages(manpages) +Refer following articles for reference on writing manpages: + +* [Linux Man Page Howto](http://www.schweikhardt.net/man_page_howto.html) +* [The GNU Troff Manual: Macro Packages » man » Usage](https://www.gnu.org/software/groff/manual/html_node/Man-usage.html#Man-usage) + ## Improving Code There's so many aspects of the code that can be improved, however please consider the following topics while doing so. diff --git a/src/woeusb.1 b/src/woeusb.1 index 70a8f66..df0564f 100644 --- a/src/woeusb.1 +++ b/src/woeusb.1 @@ -1,5 +1,3 @@ -.\" Linux Man Page Howto -.\" http://www.schweikhardt.net/man_page_howto.html .TH man 6 "3 October 2010" "1.0" "woeusb" .SH NAME woeusb \- A simple command line tool to create Windows Installation's USB stick under Linux. diff --git a/src/woeusbgui.1 b/src/woeusbgui.1 index 71f06be..388e4bc 100644 --- a/src/woeusbgui.1 +++ b/src/woeusbgui.1 @@ -1,5 +1,3 @@ -.\" Linux Man Page Howto -.\" http://www.schweikhardt.net/man_page_howto.html .TH man 6 "3 October 2010" "1.0" "woeusbgui" .SH NAME woeusbgui \- A graphical interface for woeusb(1).