make readme rst-compatible master
authorChristian Weiske <cweiske@cweiske.de>
Wed, 7 Dec 2011 19:24:33 +0000 (20:24 +0100)
committerChristian Weiske <cweiske@cweiske.de>
Wed, 7 Dec 2011 19:24:33 +0000 (20:24 +0100)
.gitignore
README.rst

index 4f4773f..8cd1440 100644 (file)
@@ -1 +1,2 @@
 config.php
+README.html
index f7f550f..f3c95c1 100644 (file)
@@ -1,21 +1,23 @@
 AWStats helper scripts
 ======================
 
-We use AWStats [1] to get statistics about the web sites hosted
-on our server. Setting up AWStats for a single site is easy,
-but for multiple domains it is really tedious work.
+We use AWStats[1] to get statistics about the web sites hosted
+on our server.
+Setting up AWStats for a single site is easy, but for multiple domains
+it is really tedious work.
 Further, the tools provided with AWStats that support multiple
 configuration files do not support historic data.
 There is i.e. no way to look at the detailled statistics of last month
 or the stats for a site of two years ago.
 
 These scripts provide the following functionality:
+
 - Rendering of historical data
 - Updating the current month's data and regenerating report files
 - Regenerating last month's report files
 - Index page generation linking to all this data
 
-The scripts utilize awstats.pl and awstats_buildstaticpages.pl
+The scripts utilize ``awstats.pl`` and ``awstats_buildstaticpages.pl``
 from the AWStats distribution.
 
 [1] http://awstats.sourceforge.net/
@@ -24,12 +26,12 @@ from the AWStats distribution.
 
 Installation
 ------------
-1. copy config.php.dist to config.php
-2. Adjust config.php to your needs
-3. Run update-sites.php to generate initial data collection
-4. Run create-historic.php to create all historic files
-5. Add update-sites.php to your crontab, let it run every hour
-6. Add update-lastmonth.php to your crontab and let it run
+0. copy ``config.php.dist`` to ``config.php``
+1. Adjust ``config.php`` to your needs
+2. Run ``update-sites.php`` to generate initial data collection
+3. Run ``create-historic.php`` to create all historic files
+4. Add ``update-sites.php`` to your crontab, let it run every hour
+5. Add ``update-lastmonth.php`` to your crontab and let it run
    on the first day every month