Imported from archive.
[weather.git] / README
1 GENERAL INFORMATION ABOUT THE WEATHER UTILITY
2
3 Copyright (c) 2006 Jeremy Stanley <fungi@yuggoth.org>, all rights reserved.
4 Licensed per terms in the LICENSE file distributed with this software.
5
6
7 WHAT?
8
9 This command-line utility is intended to provide quick access to
10 current weather conditions and forecasts. Presently, it is
11 capable of returning data for localities throughout the USA by
12 retrieving and formatting decoded METARs (Meteorological
13 Aerodrome Reports) from NOAA (the National Oceanic and
14 Atmospheric Administration) and forecasts from the NWS (National
15 Weather Service). The tool is written to function in the same
16 spirit as other command-line informational utilities like cal(1),
17 calendar(1) and dict(1). It can retrieve arbitrary weather data
18 via specific command-line switches (station ID, city, state), or
19 aliases can be configured system wide and on a per-user basis. It
20 can be freely used and redistributed under the terms of the BSD
21 License.
22
23
24 WHY?
25
26 My girlfriend has a long commute to/from work and school, and
27 often wants to check the weather both for home and her office.
28 Unfortunately, starting a Web browser, pulling up a weather site,
29 entering multiple ZIP codes and waiting for them to load is
30 time-consuming for the marginally-impatient. Since she tends to
31 stay logged into a shell server most of the time, I figured I'd
32 install a quick command-line tool to retrieve weather info for
33 her commute, but to my surprise, a quick search turned up little
34 that met my basic requirements:
35
36   * retrieve current data on-demand
37   * provide both current conditions and short-term forecasts
38   * simple, human-readable output
39   * easy to configure and use
40   * flexible command-line switches and options
41
42
43 WHERE?
44
45 A tarball for the most recent version of the weather utility can
46 be had here:
47
48    http://fungi.yuggoth.org/weather/src/
49
50 Alternatively, Debian Etch (testing) and Sid (unstable) users can
51 install the weather-util package from any mirror.
52