1
                  w2do - a simple text-based todo manager
2
3
                         installation instructions
4
5
6
   Copyright (C) 2008, 2009, 2010 Jaromir Hradilek
7
8
   Permission is granted to copy, distribute and/or modify this document
9
   under the terms of the GNU Free Documentation License, Version 1.3 or
10
   any later version published by the Free Software Foundation;  with no
11
   Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
12
13
   A copy  of the license is included  as a file called FDL  in the main
14
   directory of the w2do source package.
15
16
17
1. General System Requirements
18
19
All parts  of w2do package  are standalone scripts  written in Perl  and as
20
such, they should be platform independent. However, working installation of
21
Perl 5 is required in  order to run these scripts. If you  are using one of
22
Unix-like operating systems, it is highly probable that you have it already
23
installed.  If you are using Windows,  you can download it  free of  charge
24
from <http://www.activestate.com/Products/activeperl/>.
25
26
27
2. Installing on Unix Systems
28
29
The easiest way to install w2do on Unix operating system (e.g. Linux, vari-
30
ous *BSD systems etc.) is to use the existing Makefile. As a root, get into
31
the src/ directory in the w2do source package and type:
32
33
  make install
34
35
This will install all executables  and their corresponding man pages to the
36
predefined /usr/local/bin and /usr/local/share/man  respectively.  If these
37
locations do not satisfy your needs,  you can either edit the relevant part
38
of the Makefile, or you can change the prefix directly on the command line:
39
40
  make prefix=/some/location install
41
42
Similarly, typing
43
44
  make uninstall
45
46
or, if you have previously changed the destination directory,
47
48
  make prefix=/some/location uninstall
49
50
will completely remove all installed files.
51
52
On the other hand, you can also run the scripts directly from their present
53
location or copy the content of src/ directory somewhere in the $PATH your-
54
self.
55
56
57
3. Installing on Windows
58
59
No  special  installation  is required  in order to run  w2do on  Microsoft
60
Windows. In your favourite command line interpreter  (e.g. cmd.exe), simply
61
get into the src/ directory of the w2do source package and type:
62
63
  perl w2do [options]
64
65
etc. Try `--help' switch to get information about the usage.