README

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