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