root/trunk/README

Revision 250, 2.5 kB (checked in by andy, 3 months ago)

Improve the README file

Line 
1Pybackpack - A simple file backup tool
2--------------------------------------
3
4What is Pybackpack?
5-------------------
6
7Pybackpack is a graphical application designed to make file backup easy for the
8average user. It allows the user to specify named sets of files and directories
9to be be backed up so that the backups can be run many times. Where possible
10Pybackpack does incremental backups; it is a graphical front-end to
11rdiff-backup. Pybackpack can backup files to remote locations over the network,
12local file systems, and optical media such as writable CDs or DVDs.
13
14What is Pybackpack not?
15-----------------------
16
17It is not for backing up entire systems. Running Pybackpack as root is not
18recommended. It does not create encrypted backups or backup special files
19(device nodes, sockets, FIFOs).
20
21History
22-------
23
24Dave Arter created Pybackpack for Fedora Core as a Google Summer of Code
25project in 2005. Since August 2006 it has been maintained by Andrew Price.
26Swansea University Computer Society has kindly provided project hosting for it
27since the beginning. For a more detailed feature history see the CHANGELOG
28file.
29
30Reporting Bugs
31--------------
32
33If you are using a Pybackpack package packaged for your operating system
34distribution (e.g. from the Ubuntu, Debian or Fedora package repositories) then
35use the bug reporting systems for that distribution (e.g. Launchpad, BTS, or
36Bugzilla).
37
38If you are using an original tarball or svn version of Pybackpack, open a new
39ticket on the Trac instance:
40
41  http://projects.sucs.org/projects/pybackpack#Bugs
42
43Or the mailing list:
44
45  http://lists.sucs.org/mailman/listinfo/pybackpack
46
47In all cases please provide the version of Pybackpack you are using and as much
48detail about the bug as you can.
49
50Patches and testing
51-------------------
52
53All patches should be against the latest trunk code in the subversion
54repository. For more details:
55
56  http://projects.sucs.org/projects/pybackpack#DevelopTest
57
58Localization
59-------------
60
61For information about translating Pybackpack to your own language:
62
63  http://projects.sucs.org/projects/pybackpack/wiki/TranslationGuide
64
65License
66-------
67
68Pybackpack is free software; you can redistribute it and/or modify it under the
69terms of the GNU General Public License as published by the Free Software
70Foundation; either version 2 of the License, or (at your option) any later
71version.
72
73This program is distributed in the hope that it will be useful, but WITHOUT ANY
74WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
75PARTICULAR PURPOSE.  See the LICENSE file for more details.
76
Note: See TracBrowser for help on using the browser.