--  README for bbweather 0.6.3 - a tool which displays the current 
--  weather conditions in a decorated X11-Window.

--  Copyright (c) 2001,2003,2004,2005,2006 by Jan Schaumann

--  based on bbdate:
--  Copyright (c) 1998 by John Kennis
--  parts Copyright (c) 1997,1998 by Brad Hughes.

--  This program is free software; you can redistribute it and/or modify
--  it under the terms of the GNU General Public License as published by
--  the Free Software Foundation; either version 2 of the License, or
--  (at your option) any later version.
--
--  This program is distributed in the hope that it will be useful,
--  but WITHOUT ANY WARRANTY; without even the implied warranty of
--  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
--  GNU General Public License for more details.
--
--  You should have received a copy of the GNU General Public License
--  along with this program; if not, write to the Free Software
--  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
--
-- (See the included file COPYING / GPL-2.0)
--

This Tool displays the current weather conditions in an decorated window,
simulating the look of the Blackbox toolbar (Blackbox is a Windowmanager for
X11).  This tool is heavily based on "bbdate" by John Kennis, almost 90% of
the code (rough guess ;) were taken over unaltered.  Furthermore, bbweather
was inspired by wmWeather by Michael G. Henderson, from where I grabbed the
perl-script that fetches the weather-conditions from your local station.

This is version 0.6.3 of bbweather.

To use bbweather, you will need to know the station-ID of a weather-station to
grab the information from.  You can find out which stations are near you at
http://www.nws.noaa.gov/oso/siteloc.shtml

Once you determined the proper station, you need to run the perl-script
"GrabWeather" with that ID as the first command-line parameter.  Since you
probably want to stay updated on the weather conditions, you might consider
adding an entry to your crontab:

0 * * * * /path/to/GrabWeather StationID

This will create a directory called ".wmWeatherReports" in your $HOME in which
it will place the data-files.  You can then run bbweather:

bbweather StationID

If you prefer celsius over fahrenheit, pass the "-m" or the "--metric" option:

bbweather -m StationID

If you left-click on bbweather, it will display detailed weather information
in an xmessage much like wmWeather.

Per default, bbweather displays the time the data was last updated in UTC.
You can specify the local timezone by using the '-z' flag in hours deviation
from UTC.  bbweather does not automatically determine the local time, since it
may be desirable to display several windows with information from different
locations, thus allowing you to specify the local times at those places,
rather than the local time at your location.

For details, please refer to bbweather(1), the documentation in HTML format in
the "docs" directory and/or http://www.netmeister.org/apps/bbweather/

See AUTHORS for credits.
