doc/install.mdwn

   1 # Official packages
   2
   3 Pumpa is packaged in [Debian](https://packages.debian.org/search?keywords=pumpa) and [Ubuntu](http://packages.ubuntu.com/search?keywords=pumpa&searchon=names), so if you are using
   4 one of those, you can simply install it with your favourite package
   5 manager or by typing (as root or using `sudo`):
   6
   7     apt-get install pumpa
   8
   9
  10 # Third party packages
  11
  12 In addition, some third parties have provided packages or installers
  13 for other platforms listed below. Please note, that I have no control
  14 over these, so please report any problems with them to the respective
  15 packagers/authors.  Alternatively you can download the source code and
  16 compile it yourself, it's pretty easy, [[see instructions below|install#Compiling_yourself]].
  17
  18 ## Fedora Linux
  19
  20 By [Matt Molyneaux](https://microca.st/moggers87): <https://copr.fedoraproject.org/coprs/moggers87/pumpa/>
  21
  22 ["Metal Biker"](https://microca.st/howcanuhavemyusername) has a Fedora
  23 Copr repo for Pumpa and [Dianara][18]: <http://sylke.altervista.org/repo/>
  24
  25 [18]: https://jancoding.wordpress.com/category/projects/dianara/
  26
  27 ## Debian GNU/Linux (Spanish variant)
  28
  29 By [Fabián Bonetti](https://identi.ca/mamafree) configured for Spanish: <http://mamalibre.no-ip.org/>
  30
  31 ## openSUSE Linux
  32
  33 By ["XRevan86"](https://microca.st/xrevan86): <http://software.opensuse.org/package/pumpa>
  34
  35 ## Archlinux AUR
  36
  37 By ["speps"](https://aur.archlinux.org/packages/?K=speps&SeB=m): <https://aur.archlinux.org/packages/?K=pumpa>
  38
  39
  40 # Compiling yourself
  41
  42 ## Build dependencies
  43
  44 Pumpa should build with Qt 4.8 or Qt 5.0 or newer. If you are using Qt
  45 4, you will also need the [QJson library][6].
  46
  47 For example on Debian 8 "jessie" the following command should install
  48 everything needed to build the code:
  49
  50     aptitude install build-essential qt5-qmake qtbase5-dev libtidy-dev
  51
  52 If you want spell checking install the aspell library as well:
  53
  54     aptitude install libaspell-dev
  55
  56 Building with Qt 4.8 on Debian Jessie - this way building with Qt 4.8 makes Pumpa use your choice of theme i.e oxygen so it fits in better with the desktop.
  57
  58     aptitude install build-essential qt4-qmake qt4-default libtidy-dev libqjson-dev libaspell-dev
  59
  60 On Fedora I believe this should install what you need:
  61
  62     yum install gcc-c++ qt-devel qt-config qjson-devel libtidy-devel libaspell-devel
  63
  64 [6]: http://qjson.sourceforge.net/
  65
  66 ## Building
  67
  68 To download and build, type the following in your directory of choice:
  69
  70     git clone git://pumpa.branchable.com/ pumpa
  71     cd pumpa
  72     qmake     # or qmake-qt4 or qmake-qt5 in some systems
  73     make
  74
  75 If you do not wish to use the development version from git, you can also download the most recent release tarballs from <http://saz.im/software/downloads/pumpa/>.
  76
  77 On Mac OS X (Version 10.10.3) the procedures is similar; getting the dependencies and setting the build environment is different. (These notes are derived from [HowTo for building Pumpa on OS X](https://github.com/e14n/pump.io/wiki/HowTo-for-building-Pumpa-on-OS-X) by [habi@fmrl.me](http://fmrl.me/habi).)
  78
  79 [Homebrew](http://mxcl.github.io/homebrew/) can be used to install Pumpa dependencies:
  80
  81         brew install qt qjson aspell
  82
  83 To download and build pumpa, type the following in your directory of choice:
  84
  85     export LIBRARY_PATH=/usr/local/lib
  86     export CPLUS_INCLUDE_PATH=/usr/local/include
  87     git clone git://pumpa.branchable.com/ pumpa
  88     cd pumpa
  89     qmake
  90     make
  91     open .
  92
  93 You should now have a pumpa.app object (directory) in the build directory.
  94 Move pumpa.app to ~/Applications (or /Applications)
  95
  96 Axel has a blog post about
  97 [ How to build “Pumpa” QT-based pump.io client for Windows](https://axel668.wordpress.com/2013/07/18/how-to-build-pumpa-qt-based-pump-io-client-for-windows/).