From 2f8c49f94c3eaa1acc696ab493c07a27e4498830 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jonatan=20P=C3=A5lsson?= Date: Sun, 4 Jun 2017 18:44:21 +0200 Subject: [PATCH] Add requirements to README --- README.md | 27 ++++++--------------------- 1 file changed, 6 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 9c809ef..5de3a08 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,12 @@ Written by Chris Oliver Many thanks to Filip Slagter for his contributions. +Requirements +------------ +LogBot shows logs using flask, and stores logs using peewee. Install these dependencies using ``pip``: + + pip install flask peewee + Usage ----- LogBot requires Python 2. It is NOT compatible with Python 3. @@ -13,24 +19,3 @@ Configuration is done inside logbot.py. python logbot.py Example logs at https://raw.github.com/excid3/logbot/master/example_logs/2011-10-22.html - - -Channels with localised time ------ -LogBot now also supports having localised time on a per channel basis using the pytz library, allowing you to have the logs of specific channels use different timezones. -Installing pytz should be as simple as running `easy_install --upgrade pytz`, see http://pytz.sourceforge.net/#installation for details. -Don't worry, if you don't have pytz installed, LogBot will continue to show the logs timestamped with your system's localtime as it used to. - -Next you can create a simple text file at `~/.logbot-channel_locations.conf` (or wherever `CHANNEL_LOCATIONS_FILE` in logbot.py points to). -On each line you can now specify a channel name, and the timezone location of which it should use the timezone offset, separated by a space. Example: - - #excid3 America/Chicago - #netherlands Europe/Amsterdam - #aloha US/Hawaii - #space UTC - -Any channel not specified in this file will use the default timezone as specified in DEFAULT_TIMEZONE, which defaults to 'UTC'. - -If you want to see a list of all possible timezone location names you can use, run: - - python -c 'import pytz;print pytz.all_timezones'