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