INSTALL

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