INSTALL

   1 ==============================================================
   2  Basic Unix Installation Instructions for 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 Prerequisites
  12 -------------
  13 You need the Python interpreter installed somewhere in your path (most modern
  14 UNIX derivatives come with one already). If you need to get Python, it can be
  15 obtained from http://www.python.org/ (but chances are your operating system at
  16 least provides some sort of native package for it, which you should probably
  17 install in whatever means is recommended by your OS vendor/distributor).
  18
  19 Running in Place
  20 ----------------
  21 An easy way to try it out is to unpack the tarball and change to the resulting
  22 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 documentation are
  34 all fully functional when kept together in one directory, if somewhat
  35 inconvenient.
  36
  37 Installing the Utility
  38 ----------------------
  39 The file named weather should be made executable and put somewhere in your path
  40 (/usr/local/bin/ or ~/bin/ for example). Similarly, weather.py needs to be
  41 somewhere in Python's include path. You can see your Python interpreter's
  42 default include path by running::
  43
  44    python -c "import sys ; print sys.path"
  45
  46 Configuration
  47 -------------
  48 The weatherrc file should go in /etc/ or you can save it in your home directory
  49 as a dotfile (~/.weatherrc) to support user-specific alias configuration and
  50 overrides of the global /etc/weatherrc file.
  51
  52 Manuals
  53 -------
  54 Optionally, the weather.1 and weatherrc.5 files can be placed in sane locations
  55 for TROFF/NROFF manual files on your system (for example, /usr/local/share/man/
  56 or ~/man/).