Changed packaging.

- Drop .yapfaqrc and yapfaq.cfg in favor of .yapfaqrc.sample
  and yapfaq.cfg.sample; rename test.txt to sample.txt.
- Change contents of these files to reflect the new names.
- Update some defaults, change sample.txt contents to English.
- Add "INSTALLATION" chapter to documentation.

Fixes #7.

Signed-off-by: Thomas Hochstein <thh@inter.net>

diff --git a/.yapfaqrc b/.yapfaqrc
deleted file mode 100644 (file)
index 9b73fe3..0000000
--- a/.yapfaqrc
+++ /dev/null
@@ -1,6 +0,0 @@
-NNTPServer = 'localhost'
-NNTPUser   = ''
-NNTPPass   = ''
-Sender     = ''
-ConfigFile = 'yapfaq.cfg'
-Program    = ''

diff --git a/.yapfaqrc.sample b/.yapfaqrc.sample
new file mode 100644 (file)
index 0000000..d8c9b8a
--- /dev/null
+++ b/.yapfaqrc.sample
@@ -0,0 +1,6 @@
+NNTPServer = 'localhost'
+NNTPUser   = ''
+NNTPPass   = ''
+Sender     = ''
+ConfigFile = 'yapfaq.cfg.sample'
+Program    = ''

diff --git a/sample.txt b/sample.txt
new file mode 100644 (file)
index 0000000..c881584
--- /dev/null
+++ b/sample.txt
@@ -0,0 +1,9 @@
+Last-modified: 2010-05-15
+
+This is a test message.
+
+Foo.
+
+Bar.
+
+That's quite enought, isn't it?

diff --git a/test.txt b/test.txt
deleted file mode 100644 (file)
index 841b5c2..0000000
--- a/test.txt
+++ /dev/null
@@ -1,11 +0,0 @@
-Last-modified: 2003-01-11
-
-Dies ist ein Test-Artikel. Klasse, was?
-
-Bla.
-
-Noch mehr foo.
-
-Bar.
-
-Nu reicht's.

diff --git a/yapfaq.cfg b/yapfaq.cfg
deleted file mode 100644 (file)
index 3f68df8..0000000
--- a/yapfaq.cfg
+++ /dev/null
@@ -1,48 +0,0 @@
-# name of your project
-Name = 'testpost'
-
-# file to post (complete body and pseudo-headers)
-# ($File.cfg contains data on last posting and last MID)
-File = 'test.txt'
-
-# how often your project should be posted
-# use (d)ay OR (w)eek OR (m)onth OR (y)ear
-Posting-frequency = '1d'
-
-# time period after which the posting should expire
-# use (d)ay OR (w)eek OR (m)onth OR (y)ear
-# This setting is optional. Default: 3m
-# Expires = '3m'
-
-# header "From:"
-From = 'test@domain.invalid'
-
-# header "Subject:"
-# (may contain "%LM" which will be replaced by the contents of the
-#  Last-Modified pseudo header).
-Subject = 'test noreply ignore'
-
-# comma-separated list of newsgroup(s) to post to
-# (header "Newsgroups:")
-NGs = 'de.test'
-
-# header "Followup-To:"
-# This setting is optional. Default: unset
-# Fup2 = 'poster'
-
-# Message-ID ("%n" is $Name)
-# This setting is optional. Default: <%n-%d.%m.%y@YOURHOST>
-# MID-Format = '<%n-%d.%m.%y@domain.invalid>'
-
-# Supersede last posting?
-# This setting is optional. Default: unset
-Supersede = yes
-
-# extra headers (appended verbatim)
-# use this for custom headers like "Approved:"
-# This setting is optional. Default: unset
-ExtraHeader = 'Approved: moderator@domain.invalid
-X-Header: Some text'
-
-# other projects may follow separated with "====="
-# =====

diff --git a/yapfaq.cfg.sample b/yapfaq.cfg.sample
new file mode 100644 (file)
index 0000000..7990223
--- /dev/null
+++ b/yapfaq.cfg.sample
@@ -0,0 +1,48 @@
+# name of your project
+Name = 'sample'
+
+# file to post (complete body and pseudo-headers)
+# ($File.cfg contains data on last posting and last MID)
+File = 'sample.txt'
+
+# how often your project should be posted
+# use (d)ay OR (w)eek OR (m)onth OR (y)ear
+Posting-frequency = '1d'
+
+# time period after which the posting should expire
+# use (d)ay OR (w)eek OR (m)onth OR (y)ear
+# This setting is optional. Default: 3m
+# Expires = '3m'
+
+# header "From:"
+From = 'John Doe <john-doe@example.com>'
+
+# header "Subject:"
+# (may contain "%LM" which will be replaced by the contents of the
+#  Last-Modified pseudo header).
+Subject = 'test noreply ignore'
+
+# comma-separated list of newsgroup(s) to post to
+# (header "Newsgroups:")
+NGs = 'de.test'
+
+# header "Followup-To:"
+# This setting is optional. Default: unset
+# Fup2 = 'poster'
+
+# Message-ID ("%n" is $Name)
+# This setting is optional. Default: <%n-%y-%m-%d@YOURHOST>
+# MID-Format = '<%n-%y-%m-%d@domain.invalid>'
+
+# Supersede last posting?
+# This setting is optional. Default: unset
+Supersede = yes
+
+# extra headers (appended verbatim)
+# use this for custom headers like "Approved:"
+# This setting is optional. Default: unset
+ExtraHeader = 'Approved: moderator@domain.invalid
+X-Header: Some text'
+
+# other projects may follow separated with "====="
+# =====

diff --git a/yapfaq.pl b/yapfaq.pl
index bde4d50..1257e63 100644 (file)
--- a/yapfaq.pl
+++ b/yapfaq.pl
@@ -748,6 +748,19 @@ to or load another configuration file defining (an)other FAQ(s).
 
 =back
 
 
 =back
 

+=head1 INSTALLATION
+
+Just copy the contents of the tarball in some directory and get started.
+
+You can post your first test with
+
+    yapfaq -c .yapfaqrc.sample
+
+or copy F<.yapfaqrc.sample> to F<.yapfaqrc> and F<yapfaq.cfg.sample>
+to F<yapfaq.cfg>, edit those files and get really started!
+
+=back
+

 =head1 EXAMPLES
 
 Post all FAQs that are due for posting:
 =head1 EXAMPLES
 
 Post all FAQs that are due for posting: