Skip to content

Commit

Permalink
Move help on writing manpages to Contributing Guide
Browse files Browse the repository at this point in the history
Signed-off-by: 林博仁 <Buo.Ren.Lin@gmail.com>
  • Loading branch information
brlin-tw committed Jun 15, 2017
1 parent 2cc25d8 commit 7c6198e
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 4 deletions.
9 changes: 9 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 0 additions & 2 deletions src/woeusb.1
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 0 additions & 2 deletions src/woeusbgui.1
Original file line number Diff line number Diff line change
@@ -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).
Expand Down

0 comments on commit 7c6198e

Please sign in to comment.