README

   1 WhisperBack - Send feedback via encrypted e-mail
   2 ################################################
   3
   4 Copyright (C) 2009-2018 Tails developers <tails@boum.org>
   5
   6 DESCRIPTION
   7 ===========
   8
   9 WhisperBack is a small pyGTK application intended to provide
  10 a user-friendly way to send feedback to the Tails dev team in
  11 a GnuPG-encrypted way.
  12
  13
  14 DEPENDENCIES
  15 ============
  16
  17 See debian/control.
  18
  19 INSTALLATION
  20 ============
  21
  22 WhisperBack is packaged using Python distutils.
  23
  24 Build dependencies:
  25
  26   # apt install python3-distutils-extra txt2tags
  27
  28 To install it:
  29
  30   $ ./setup.py build
  31
  32 and as root:
  33
  34   # ./setup.py install
  35
  36 To run it:
  37
  38   $ ./whisperback
  39
  40 CONFIGURATION
  41 =============
  42
  43 The configuration is read in sequence from the following files,
  44 settings read last overriding previous ones:
  45 - /etc/whisperback/config.py
  46 - ~/.whisperback/config.py
  47 - ./config.py
  48
  49 The config.py.sample example configuration file will tell you about the
  50 configuration syntax and available settings.
  51
  52
  53 USAGE
  54 =====
  55
  56 Please see the man page.
  57
  58
  59 LICENSING
  60 =========
  61
  62 This file is part of WhisperBack.
  63
  64 WhisperBack is  free software; you can redistribute  it and/or modify
  65 it under the  terms of the GNU General Public  License as published by
  66 the Free Software Foundation; either  version 3 of the License, or (at
  67 your option) any later version.
  68
  69 This program  is distributed in the  hope that it will  be useful, but
  70 WITHOUT   ANY  WARRANTY;   without  even   the  implied   warranty  of
  71 MERCHANTABILITY  or FITNESS  FOR A  PARTICULAR PURPOSE.   See  the GNU
  72 General Public License for more details.
  73
  74 You should have received a copy of the GNU General Public License
  75 along with this program.  If not, see <http://www.gnu.org/licenses/>.
  76
  77 Please see COPYING for more information.