summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul C. Buetow (mars.fritz.box) <paul@buetow.org>2014-06-22 11:36:34 +0200
committerPaul C. Buetow (mars.fritz.box) <paul@buetow.org>2014-06-22 11:36:34 +0200
commit5c7b2727b372bde0d5e133238a8a0fd621f422cd (patch)
tree9d601432f07e7105ea9833aac0221a34b3bc2f56
parent204066274c592f0787c79c7aa1d49af5abc1c596 (diff)
add README.pod for github1.0.2
-rw-r--r--Makefile2
-rw-r--r--README.pod22
-rw-r--r--docs/cpuinfo.12
3 files changed, 25 insertions, 1 deletions
diff --git a/Makefile b/Makefile
index 0911977..3bb962e 100644
--- a/Makefile
+++ b/Makefile
@@ -30,6 +30,8 @@ documentation:
pod2man --release="$(NAME) $$(cat .version)" \
--center="User Commands" ./docs/$(NAME).pod > ./docs/$(NAME).1
pod2text ./docs/$(NAME).pod > ./docs/$(NAME).txt
+ # For github page
+ cp ./docs/$(NAME).pod README.pod
# Build a debian package (don't sign it, modify the arguments if you want to sign it)
deb: all
diff --git a/README.pod b/README.pod
new file mode 100644
index 0000000..63ccb43
--- /dev/null
+++ b/README.pod
@@ -0,0 +1,22 @@
+=head1 NAME
+
+cpuinfo - A small and humble tool to print out CPU data
+
+=head1 SYNOPSIS
+
+cpuinfo
+
+=head2 How this works?
+
+This just invokes AWK to parse /proc/cpuinfo and prints out some stuff but
+human readable.
+
+=head1 LICENSE
+
+See package description or project website.
+
+=head1 AUTHOR
+
+Paul Buetow - <http://cpuinfo.buetow.org>
+
+=cut
diff --git a/docs/cpuinfo.1 b/docs/cpuinfo.1
index 601416c..f9db8bb 100644
--- a/docs/cpuinfo.1
+++ b/docs/cpuinfo.1
@@ -124,7 +124,7 @@
.\" ========================================================================
.\"
.IX Title "CPUINFO 1"
-.TH CPUINFO 1 "2013-07-26" "cpuinfo 1.0.1" "User Commands"
+.TH CPUINFO 1 "2014-06-22" "cpuinfo 1.0.1" "User Commands"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l