From 27f2157bf88c1de9452686da12ad3d3568dcd040 Mon Sep 17 00:00:00 2001
From: Denis Knauf <Denis.Knauf@gmail.com>
Date: Wed, 17 Mar 2010 13:27:28 +0100
Subject: [PATCH] more readme

---
 README.md | 44 +++++++++++++++++++++-----------------------
 1 file changed, 21 insertions(+), 23 deletions(-)

diff --git a/README.md b/README.md
index b0c6832..dd56266 100644
--- a/README.md
+++ b/README.md
@@ -1,58 +1,59 @@
 Dependencies
 ============
 
-incomplete yet.
-
 System
 ------
 
 * ruby >= 1.9 (tested: 1.9.1,  untested: 1.8 (maybe compatible))
-* libdb >= 4 (tested: 4.7)
-* C-Compiler
+* libdb >= 4.7 (tested: 4.7/4.8)
+* C-Compiler (tested: gcc 4.4.1)
 
 ### Debian/Ubuntu:
 
 	# aptitude ruby1.9.1 ruby1.9.1-dev libdb4.7-dev rubygems1.9.1
 
-If you've installed ruby1.8 (yet), you should run ruby1.9.1 instead ruby and
+If you've installed ruby1.8 (yet),  you should run ruby1.9.1 instead ruby and
 gem1.9.1 instead gem.
 Change shebash in s2l.rb to
 
 	#!/usr/bin/ruby1.9.1
 
+or
+
+	#!/usr/bin/env ruby1.9.1
 
 Ruby Gems
 ---------
 
-* BDB >= 0.2.2 (patch needed - gem included)
-* UUIDTools
+You should install *dk-bdb* manualy:
 
-Install: (in syslog2logan-dir)
-
-	# gem install bdb-0.2.2.gem uuidtools
+	# gem install dk-bdb -- --with-db-dir=/usr --with-db-include=/usr/include
 
+Every other dependencies will be installed automaticaly,
+if you install syslog2logan via gem.
 
 Install
 =======
 
-	# gem build syslog2logan.gemspec
-	# gem install syslog2logan-*.gem
-
+	# gem install syslog2logan
 
 Usage
 =====
 
+First you should know,  the database environments are in *this* directory,
+where you call *s2l.rb*.  You must use this directory for logan itself too!
+Don't use this directory for anything else.
+
 Start
 -----
 
-Simple:
+Simple on Ubuntu:
 
-	# ./s2l.rb
+	# /var/lib/gems/1.9*/gems/syslog2logan-*/bin/s2l.rb
 
-Or deamonized:
-
-	# sh -c 'nohup ./s2l.rb </dev/null >/dev/null 2>&1 &' &
+Deamonized:
 
+	# sh -c 'nohup PATHTO/s2l.rb </dev/null >/dev/null 2>&1 &' &
 
 Use it
 ------
@@ -67,7 +68,7 @@ You need these lines:
 
 	source s_server {
 		unix-stream( "/dev/log" max-connections(100));
-		# internal(); # Statistics about dests. You've any other dest than the server?
+		# internal(); # Statistics about dests.  It's unimportant for LogAn.
 		file( "/proc/kmsg");
 	};
 	
@@ -80,9 +81,6 @@ You need these lines:
 		destination( d_server);
 	};
 
-You should use your default source.
-
-
 ### rsyslog
 
-I don't know.  Please tell me,  if you can.
+I don't know.  Please tell me,  how to use.