INSTALL

   1 BASIC UNIX INSTALLATION INSTRUCTIONS FOR 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 PREREQUISITES
  10
  11 You need the Python interpreter installed somewhere in your path
  12 (most modern UNIX derivatives come with one already). If you need to
  13 get Python, it can be obtained from http://www.python.org/ (but
  14 chances are your operating system at least provides some sort of
  15 native package for it, which you should probably install in whatever
  16 means is recommended by your OS vendor/distributor).
  17
  18
  19 RUNNING IN PLACE
  20
  21 An easy way to try it out is to unpack the tarball and change to the
  22 resulting directory:
  23
  24    tar xzf weather-*.tar.gz
  25    cd weather
  26    ./weather --version
  27    ./weather --help
  28    man ./weather.1
  29    man ./weatherrc.5
  30    ./weather --forecast --no-conditions --city=charlotte --st=nc
  31    ./weather ord sea
  32
  33 ...and so on. The weather utility, included Python module and
  34 documentation are all fully functional when kept together in one
  35 directory, if somewhat inconvenient.
  36
  37
  38 INSTALLING THE UTILITY
  39
  40 The file named weather should be made executable and put somewhere
  41 in your path (/usr/local/bin/ or ~/bin/ for example). Similarly,
  42 weather.py needs to be somewhere in Python's include path. You can
  43 see your Python interpreter's default include path by running:
  44
  45    python -c "import sys ; print sys.path"
  46
  47
  48 CONFIGURATION
  49
  50 The weatherrc file should go in /etc/ or you can save it in your
  51 home directory as a dotfile (~/.weatherrc) to support user-specific
  52 alias configuration and overrides of the global /etc/weatherrc file.
  53
  54
  55 MANUALS
  56
  57 Optionally, the weather.1 and weatherrc.5 files can be placed in
  58 sane locations for TROFF/NROFF manual files on your system (for
  59 example, /usr/local/share/man/ or ~/man/).