Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

Biogem-specific instructions #1

Merged
merged 2 commits into from Apr 2, 2012
Jump to file or symbol
Failed to load files and symbols.
+15 −0
Split
View
@@ -166,6 +166,21 @@ For parsing command line options with the OptionParser:
# Realize settings
Bio::Log::CLI.configure('mylog')
+== Biogems
+
+The recommended way to use bio-logger from within a biogem is to setup a
+logger in lib/bio-gemname.rb (where you replace gemname with the name of your
+gem, of course) like so:
+
+ # bioruby-gemname/lib/bio-gemname.rb
+ require 'bio-logger'
+ Bio::Log::LoggerPlus.new('bio-gemname')
+
+Then the log can be written to anywhere within the biogem's code e.g.
+
+ log = Bio::Log::LoggerPlus['bio-gemname']
+ log.debug "a debug message"
+
== Documentation
The log4r documentation and source code can be used, as this Logger