From c4765a39f36bcfe09e041d1931d7778a8769a3e1 Mon Sep 17 00:00:00 2001
From: Thomas Hochstein <thh@inter.net>
Date: Sat, 15 May 2010 19:16:40 +0200
Subject: [PATCH] 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>
---
 .yapfaqrc => .yapfaqrc.sample   |  2 +-
 sample.txt                      |  9 +++++++++
 test.txt                        | 11 -----------
 yapfaq.cfg => yapfaq.cfg.sample | 10 +++++-----
 yapfaq.pl                       | 13 +++++++++++++
 5 files changed, 28 insertions(+), 17 deletions(-)
 rename .yapfaqrc => .yapfaqrc.sample (72%)
 create mode 100644 sample.txt
 delete mode 100644 test.txt
 rename yapfaq.cfg => yapfaq.cfg.sample (85%)

diff --git a/.yapfaqrc b/.yapfaqrc.sample
similarity index 72%
rename from .yapfaqrc
rename to .yapfaqrc.sample
index 9b73fe3..d8c9b8a 100644
--- a/.yapfaqrc
+++ b/.yapfaqrc.sample
@@ -2,5 +2,5 @@ NNTPServer = 'localhost'
 NNTPUser   = ''
 NNTPPass   = ''
 Sender     = ''
-ConfigFile = 'yapfaq.cfg'
+ConfigFile = 'yapfaq.cfg.sample'
 Program    = ''
diff --git a/sample.txt b/sample.txt
new file mode 100644
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
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.sample
similarity index 85%
rename from yapfaq.cfg
rename to yapfaq.cfg.sample
index 3f68df8..7990223 100644
--- a/yapfaq.cfg
+++ b/yapfaq.cfg.sample
@@ -1,9 +1,9 @@
 # name of your project
-Name = 'testpost'
+Name = 'sample'
 
 # file to post (complete body and pseudo-headers)
 # ($File.cfg contains data on last posting and last MID)
-File = 'test.txt'
+File = 'sample.txt'
 
 # how often your project should be posted
 # use (d)ay OR (w)eek OR (m)onth OR (y)ear
@@ -15,7 +15,7 @@ Posting-frequency = '1d'
 # Expires = '3m'
 
 # header "From:"
-From = 'test@domain.invalid'
+From = 'John Doe <john-doe@example.com>'
 
 # header "Subject:"
 # (may contain "%LM" which will be replaced by the contents of the
@@ -31,8 +31,8 @@ NGs = 'de.test'
 # 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>'
+# 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
diff --git a/yapfaq.pl b/yapfaq.pl
index bde4d50..1257e63 100644
--- a/yapfaq.pl
+++ b/yapfaq.pl
@@ -748,6 +748,19 @@ to or load another configuration file defining (an)other FAQ(s).
 
 =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:
-- 
2.20.1