INSTALL

   1
   2
   3 NomNom
   4 ===============
   5
   6 PREREQUISITES
   7
   8 * quvi (0.2.8+)     <http://quvi.googlecode.com/>
   9 * curl (7.20.0+)    <http://curl.haxx.se/>
  10 * qt   (4.7+)       <http://qt.nokia.com/>
  11 * media player
  12   - that supports streaming (e.g. vlc)
  13
  14 -- Optional
  15 * umph (0.1.7+)     <http://umph.googlecode.com/>
  16
  17 -- To compile
  18 * gcc/g++   (4.5.0+)
  19 * cmake     (2.8.2+)
  20
  21 The above versions have been tested, earlier versions _may_ work (apart from
  22 quvi).
  23
  24
  25 INSTALLATION
  26
  27 % tar xf nomnom-$release.tar.gz ; cd nomnom-$release
  28 % mkdir tmp ; cd tmp
  29 % cmake -DCMAKE_BUILD_TYPE=debug -DCMAKE_INSTALL_PREFIX=/usr ..
  30 % make
  31 % make install # as root
  32 ...
  33 % make uninstall # as root
  34
  35
  36 INSTALLATION VARIABLES
  37
  38 These may be some of the frequently used ones.
  39
  40     * CMAKE_INSTALL_PREFIX=$path
  41         Install destination for NomNom, system default may vary.
  42
  43     * CMAKE_BUILD_TYPE=(none|debug|release|relwithdebinfo|minsizerel)
  44         Type of build, default is "debug".
  45
  46     * CMAKE_VERBOSE_MAKEFILE=(true,false)
  47         Build with verbose makefiles, default is "false".
  48
  49 Example:
  50     % mkdir tmp; cd tmp
  51     % cmake -DCMAKE_INSTALL_PREFIX=/usr/local ..
  52     % make install
  53
  54 You can also run cmake with -i (wizard mode).
  55
  56 Edit CMakeLists.txt file if you need to dig deeper.
  57 See also the CMake (2.8) documentation at:
  58     <http://www.cmake.org/cmake/help/cmake-2-8-docs.html>
  59
  60
  61 NOTES FOR PACKAGERS
  62
  63 1) Porting.
  64
  65 Please ask the platform specific questions from those familiar with your
  66 platform. We're currently Linux only.
  67
  68 If you need an additional check for, e.g. a symbol or a function, see the
  69 top-level CMakeLists.txt file and the config.h.in file. We can add those
  70 at the upstream if that makes porting easier.
  71
  72 2) Default system wide configuration file.
  73
  74 From users' perspective, configuring NomNom is likely the most demanding
  75 part of the application.
  76
  77 Please consider including a preconfigured (e.g. system wide) config file
  78 in your package tailored for your distro.
  79
  80 Open the Preferences, select Other to see where NomNom saves your config
  81 file. You can use the file as a template for your package.
  82
  83 For example:
  84
  85     quvi: /usr/bin/quvi %u
  86     curl: /usr/bin/curl -L -C - -o %f %u
  87     player: /usr/bin/vlc --quiet %u
  88
  89 NomNom sets the above values (without paths) by default if nothing was
  90 found.
  91
  92 For the details, refer to the Qt's QSettings class reference and platform
  93 specific notes (below) about the system wide configuration. On Unix-like
  94 systems, QSettings typically checks the following paths:
  95
  96     /etc/xdg/NomNom/NomNom.conf
  97     /etc/xdg/NomNom.conf
  98     /etc/NomNom.conf
  99
 100 Note that this may vary depending on how the Qt was configured and packaged
 101 for your distro. See also:
 102
 103     <http://doc.trolltech.com/4.7/qsettings.html>
 104     <http://doc.trolltech.com/4.7/qsettings.html#platform-specific-notes>