home *** CD-ROM | disk | FTP | other *** search
/ Freelog 125 / Freelog_MarsAvril2015_No125.iso / Internet / gpodder / gpodder-portable.exe / gpodder-portable / README < prev   
Text File  |  2014-10-30  |  10KB  |  279 lines
  1.  
  2.                           ___         _    _           ____
  3.                      __ _| _ \___  __| |__| |___ _ _  |__ /
  4.                     / _` |  _/ _ \/ _` / _` / -_) '_|  |_ \
  5.                     \__, |_| \___/\__,_\__,_\___|_|   |___/
  6.                     |___/
  7.                           Media aggregator and podcast client
  8.  
  9.   ............................................................................
  10.  
  11.              Copyright  2005-2014 Thomas Perl and the gPodder Team
  12.  
  13.  
  14.  [ LICENSE ]
  15.  
  16.     gPodder is free software; you can redistribute it and/or modify
  17.     it under the terms of the GNU General Public License as published by
  18.     the Free Software Foundation; either version 3 of the License, or
  19.     (at your option) any later version.
  20.  
  21.     gPodder is distributed in the hope that it will be useful,
  22.     but WITHOUT ANY WARRANTY; without even the implied warranty of
  23.     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  24.     GNU General Public License for more details.
  25.  
  26.     You should have received a copy of the GNU General Public License
  27.     along with this program. If not, see <http://www.gnu.org/licenses/>.
  28.  
  29.  
  30.  
  31.  [ DEPENDENCIES ]
  32.  
  33.     - Python 2.6 or newer              http://python.org/
  34.     - "sqlite3" Python module          (usually included with Python)
  35.     - Feedparser 5.1.2 or newer        http://code.google.com/p/feedparser/
  36.     - mygpoclient 1.7 or newer         http://thp.io/2010/mygpoclient/
  37.     - Python D-Bus bindings
  38.  
  39.     gPodder might still work with Python 2.5, but you may need to
  40.     install the json module ("simplejson") manually. We reserve the
  41.     right to drop support for Python 2.5 in future point releases.
  42.  
  43.     As an alternative to python-dbus on Mac OS X and Windows, you can use
  44.     the dummy (no-op) D-Bus module provided in "tools/fake-dbus-module/".
  45.  
  46.     For quick testing, you can use the script tools/localdepends.py to
  47.     install local copies of feedparser and mygpoclient into "src/" from
  48.     PyPI. With this, you get a self-contained gPodder CLI/WebUI codebase.
  49.  
  50.  
  51.  [ GTK UI - ADDITIONAL DEPENDENCIES ]
  52.  
  53.     - PyGTK 2.16 or newer              http://pygtk.org/
  54.  
  55.  
  56.  [ QML UI - ADDITIONAL DEPENDENCIES ]
  57.  
  58.     - Qt 4.7.1 or newer                http://qt.nokia.com/
  59.     - PySide 1.0.8 or newer            http://www.pyside.org/
  60.     - Qt Mobility 1.2 or newer         http://qt.gitorious.org/qt-mobility
  61.     - Qt Quick Components              http://qt.gitorious.org/qt-components
  62.  
  63.     The QML UI depends on the QtMultimediaKit QML bindings for playing
  64.     back audio (libdeclarative-multimedia in Debian) and on the WebKit QML
  65.     bindings for Flattr integration (libqtwebkit-qmlwebkitplugin in Debian).
  66.  
  67.     The QML UI now also depends on Qt Quick Components. On MeeGo 1.2 Harmattan,
  68.     these components are pre-installed. You can install them on your Desktop by
  69.     checking out the code from the qt-components Git repository and running the
  70.     "./configure" script with the "-meego" parameter (+ the usual make install).
  71.  
  72.     You might also need to copy the theme from /usr/share/themes/blanco/ on a
  73.     MeeGo 1.2 Harmattan device to your development machine in order for all UI
  74.     elements to be displayed correctly. Alternatively, you can use the free
  75.     "darko" theme from: https://github.com/jpavelek/meego-handset-theme-darko
  76.  
  77.  
  78.  [ OPTIONAL DEPENDENCIES ]
  79.  
  80.     - Bluetooth file sending: gnome-obex-send or bluetooth-sendto
  81.     - HTML shownotes: python-webkit
  82.     - Flattr integration: python-webkit
  83.     - Size detection on Windows: PyWin32
  84.     - Native OS X support: ige-mac-integration
  85.     - MP3 Player Sync Support: python-eyed3 (0.7 or newer)
  86.     - iPod Sync Support: python-gpod
  87.  
  88.  
  89.  [ BUILD DEPENDENCIES ]
  90.  
  91.     - help2man
  92.     - intltool
  93.  
  94.  
  95.  [ TEST DEPENDENCIES ]
  96.  
  97.     - python-minimock
  98.     - python-coverage
  99.  
  100.  [ TESTING ]
  101.  
  102.     To run tests, use...
  103.         make unittest
  104.  
  105.     To set a specific python binary set PYTHON:
  106.         PYTHON=python2 make unittest
  107.  
  108.     Tests in gPodder are written in two different ways:
  109.  
  110.        - doctests (see http://docs.python.org/2/library/doctest.html)
  111.        - unittests (see http://docs.python.org/2/library/unittest.html)
  112.  
  113.     If you want to add doctests, simply write the doctest and make sure that
  114.     the module appears in "doctest_modules" in src/gpodder/unittests.py. For
  115.     example, the doctests in src/gpodder/util.py are added as 'util' (the
  116.     "gpodder" prefix must not be specified there).
  117.  
  118.     If you want to add unit tests for a specific module (ex: gpodder.model),
  119.     you should add the tests as gpodder.test.model, or in other words:
  120.  
  121.         The file       src/gpodder/model.py
  122.         is tested by   src/gpodder/test/model.py
  123.  
  124.     After you've added the test, make sure that the module appears in
  125.     "test_modules" in src/gpodder/unittests.py - for the example above, the
  126.     unittests in src/gpodder/test/model.py are added as 'model'. For unit
  127.     tests, coverage reporting happens for the tested module (that's why the
  128.     test module name should mirror the module to be tested).
  129.  
  130.  
  131.  [ RUNNING AND INSTALLATION ]
  132.  
  133.     To run gPodder from source, use..
  134.  
  135.         bin/gpodder              for the Gtk+ UI
  136.         bin/gpodder --qml        for the QML UI
  137.         bin/gpo                  for the command-line interface
  138.  
  139.     To install gPodder system-wide, use "make install". By default, this
  140.     will install *all* UIs and all translations. The following environment
  141.     variables are processed by setup.py:
  142.  
  143.         LINGUAS                  space-separated list of languages to install
  144.         GPODDER_INSTALL_UIS      space-separated list of UIs to install
  145.         GPODDER_MANPATH_NO_SHARE if set, install manpages to $PREFIX/man/man1
  146.  
  147.     See setup.py for a list of recognized UIs.
  148.  
  149.     Example: Install the CLI and Gtk UI with German and Dutch translations:
  150.  
  151.         export LINGUAS="de nl"
  152.         export GPODDER_INSTALL_UIS="cli gtk"
  153.         make install
  154.  
  155.     The "make install" target also supports DESTDIR and PREFIX for installing
  156.     into an alternative root (default /) and prefix (default /usr):
  157.  
  158.         make install DESTDIR=tmp/ PREFIX=/usr/local/
  159.  
  160.  
  161.  [ PYTHON 3 SUPPORT ]
  162.  
  163.     The CLI version of gPodder (bin/gpo) and the QML UI are compatible with
  164.     Python 3 after converting the codebase with the 2to3 utility:
  165.  
  166.       2to3 -w bin/* src share/gpodder/extensions
  167.  
  168.     You will also need a copy of "mygpoclient" converted using 2to3 and
  169.     a copy of "feedparser" converted using 2to3 (see the feedparser README
  170.     for details on how to get it set up on Python 3, including sgmllib).
  171.  
  172.     Please note that the Gtk UI is not compatible with Python 3 (it will
  173.     be once we migrate the codebase to Gtk3/GObject Introspection).
  174.  
  175.     The QML UI has been tested with PySide (Git revision a90f3bc) and
  176.     Python 3.2.2 - you can use the PySide buildscripts to build PySide:
  177.  
  178.         http://github.com/PySide/BuildScripts
  179.  
  180.     As of February 2012, Python 3 support is still experimental. Please
  181.     report any bugs that you find to the gPodder bug tracker (see below).
  182.  
  183.  
  184.  [ PORTABLE MODE / ROAMING PROFILES ]
  185.  
  186.     The run-time environment variable GPODDER_HOME is used to set
  187.     the location for storing the database and downloaded files.
  188.  
  189.     This can be used for multiple configurations or to store the
  190.     download directory directly on a MP3 player or USB disk:
  191.  
  192.         export GPODDER_HOME=/media/usbdisk/gpodder-data/
  193.  
  194.  
  195.  [ CHANGING THE DOWNLOAD DIRECTORY ]
  196.  
  197.     The run-time environment variable GPODDER_DOWNLOAD_DIR is used to
  198.     set the location for storing the downloads only (independent of the
  199.     data directory GPODDER_HOME):
  200.  
  201.         export GPODDER_DOWNLOAD_DIR=/media/BigDisk/Podcasts/
  202.  
  203.     In this case, the database and settings will be stored in the default
  204.     location, with the downloads stored in /media/BigDisk/Podcasts/.
  205.  
  206.     Another example would be to set both environment variables:
  207.  
  208.         export GPODDER_HOME=~/.config/gpodder/
  209.         export GPODDER_DOWNLOAD_DIR=~/Podcasts/
  210.  
  211.     This will store the database and settings files in ~/.config/gpodder/
  212.     and the downloads in ~/Podcasts/. If GPODDER_DOWNLOAD_DIR is not set,
  213.     $GPODDER_HOME/Downloads/ will be used if it is set.
  214.  
  215.  
  216.  [ LOGGING ]
  217.  
  218.     By default, gPodder writes log files to $GPODDER_HOME/Logs/ and removes
  219.     them after a certain amount of times. To avoid this behavior, you can set
  220.     the environment variable GPODDER_WRITE_LOGS to "no", e.g:
  221.  
  222.         export GPODDER_WRITE_LOGS=no
  223.  
  224.  
  225.  [ EXTENSIONS ]
  226.  
  227.     Extensions are normally loaded from gPodder's "extensions/" folder (in
  228.     share/gpodder/extensions/) and from $GPODDER_HOME/Extensions/ - you can
  229.     override this by setting an environment variable:
  230.  
  231.         export GPODDER_EXTENSIONS="/path/to/extension1.py extension2.py"
  232.  
  233.     In addition to that, if you want to disable loading of all extensions,
  234.     you can do this by setting the following environment variable to a non-
  235.     empty value:
  236.  
  237.         export GPODDER_DISABLE_EXTENSIONS=yes
  238.  
  239.     If you want to report a bug, please try to disable all extensions and
  240.     check if the bug still appears to see if an extension causes the bug.
  241.  
  242.  
  243.  [ TRANSLATIONS ]
  244.  
  245.     These instructions are mostly useful for the maintainer, but they are
  246.     documented here in case you want to update translations yourself:
  247.  
  248.     To upload a changed translation template:
  249.  
  250.         make messages       # update translations from source
  251.         make clean          # remove temporary files after "make messages"
  252.         tx push --source    # upload po/messages.pot to transifex.net
  253.  
  254.     To download a translation that has been updated:
  255.  
  256.         tx pull -l XX -f    # download po/XX.po from transifex.net
  257.  
  258.     To generate Git commit commands for the translation updates:
  259.  
  260.         python tools/i18n/generate_commits.py
  261.  
  262.     The "tx" command is provided by the Transifex client (transifex-client
  263.     in Debian/Ubuntu) which can be obtained from:
  264.  
  265.         http://help.transifex.com/features/client/
  266.  
  267.  
  268.  
  269.  [ MORE INFORMATION ]
  270.  
  271.     - Homepage                         http://gpodder.org/
  272.     - Bug tracker                      http://bugs.gpodder.org/
  273.     - Mailing list                     http://freelists.org/list/gpodder
  274.     - IRC channel                      #gpodder on irc.freenode.net
  275.  
  276.   ............................................................................
  277.              Last updated: 2013-02-12 by Thomas Perl <thp.io/about>
  278.  
  279.