INSTALL 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081
  1. Dependencies
  2. ============
  3. In order to install QStarDict, it is necessary to install its dependencies.
  4. Necessary dependencies:
  5. * Qt 5 (LGPLv3) https://doc.qt.io/qt-5/
  6. Optional dependencies:
  7. * GLib (LGPL-2.1-or-later) https://docs.gtk.org/glib/
  8. is used in the StarDict plugin
  9. * ZLib (License of ZLib) https://zlib.net/
  10. is used in the StarDict plugin
  11. * LibZIM (GPLv2-or-later) https://openzim.org/wiki/Libzim
  12. is used in the Kiwix plugin
  13. * ESpeak (GPLv3-or-later) https://espeak.sourceforge.net/
  14. is used for pronouncing words
  15. * Anki (AGPLv3-or-later) https://apps.ankiweb.net/
  16. is used for remembering words
  17. * KDE Frameworks: KGlobalAccel, KWindowSystem, KNotifications (LGPLv3)
  18. https://api.kde.org/frameworks/index.html
  19. are used to support showing of translation by middle click on the tray icon on KDE
  20. On Debian-based systems all of the dependencies can be installed using
  21. the following command:
  22. sudo apt install build-essential \
  23. qt5-qmake qtbase5-dev qtbase5-private-dev \
  24. qttools5-dev-tools libx11-dev \
  25. libglib2.0-dev zlib1g-dev \
  26. libzim-dev \
  27. espeak \
  28. anki \
  29. libkf5globalaccel-dev libkf5notifications-dev \
  30. libkf5windowsystem-dev
  31. Building and installing QStarDict
  32. =================================
  33. When the dependencies are installed, it is possible to build and install
  34. QStarDict using the following commands:
  35. qmake # to configure the project
  36. make -j # build, if this fails because you do not have enough RAM,
  37. # try to remove the "-j" flag
  38. sudo make install
  39. qmake switches
  40. ==============
  41. QStarDict consists of a core and plugins. There are the following plugins:
  42. * kiwix - adds support for Kiwix Wiktionary dictionaries
  43. * stardict - adds support for StarDict 2.x dictionaries
  44. * web - adds support for online web dictionaries
  45. * anki - adds a toolbar action for adding words with translations to Anki
  46. * savetofile - adds a toolbar action for saving translations to files
  47. * print - adds a toolbar action for printing translations
  48. * kdeintegration - adds support for showing translations by middle click
  49. on the tray icon on KDE
  50. By default, all of these plugins are built, although not all of them
  51. are enabled by default. If you want to select only a subset of the
  52. plugins, add ENABLED_PLUGINS option to the invocation of qmake:
  53. qmake ENABLED_PLUGINS=<selected plugins>
  54. In order to enable the developer mode for plugins, run qmake as
  55. qmake DEV=1
  56. In order to install QStarDict to an install prefix other than /usr,
  57. run qmake as
  58. qmake INSTALL_PREFIX=<install prefix>