===TEA===

Home sites >
http://semiletov.org/tea
http://tea.ourproject.org

Development >
https://github.com/psemiletov/tea-qt

AUR > https://aur.archlinux.org/packages/tea-qt/

Communities >
https://vk.com/teaeditor
https://www.facebook.com/groups/766324686841748/

CONTENTS OF THIS README:

00 - INTRO
01 - INSTALLATION FROM THE SOURCE
02 - NOTES FOR PACKAGE MAINTAINERS
03 - NOTE FOR UBUNTU USERS
04 - LICENSE NOTES
05 - DONATE

==00: INTRO==

TEA is a text editor with the hundreds of features. Yes.

==01: INSTALLATION FROM THE SOURCE===

You can install TEA from the source by 4 ways, using build systems qmake/make, meson/ninja, cmake/make, cmake/ninja. But first, you need to install some development libraries.

Mandatory:

Qt 4 or 5.4+
zlib

Optional:

libaspell (for spell checking engine)
libhunspell (for spell checking engine)
poppler-qt5 (to read the text from PDF)
ddjvuap (to read the text from DJVU)

Note for FreeBSD users: you need the pkgconf package - pkg install pkgconf


If you want to build and install TEA with cmake + make, run at the source dir:

mkdir b
cd b
cmake ..
make
make install (as root or with sudo)


To build and install TEA with cmake/ninja and GCC, do:

mkdir b
cd b
cmake -GNinja ..
ninja
ninja install


To build and install TEA with meson/ninja and GCC, do:


mkdir b
meson
cd b
ninja
ninja install

To build and install TEA with meson/ninja and CLANG, do:

mkdir b
CC=clang CXX=clang++ meson b
cd b
ninja
ninja install


With qmake it is even more simplier:

qmake
make
make install (as root or with sudo)


To make some source configuration (with qmake), use CONFIG variable at qmake command line parameter. For example:

qmake "CONFIG+=useclang" "CONFIG+=noaspell"

You can use some values:

noqml - no QML support (the preferable mode)
nosingleapp - do not build TEA with the single application mode support
nodesktop - do not install desktop files and icons
useclang - TEA will be compiled with Clang.
noaspell - disable the Aspell (if you have it installed, but  do not want to compile TEA with Aspell support)
nohunspell - disable Hunspell for TEA.
usepoppler - use libpoppler-qt5 or qt4 for PDF text layer import. DISABLED by default
usedjvu - use libdjvulibre to read DJVU files text (read only). DISABLED by default
noprinter - disable printing support

Notes:

1. If you have installed both Qt4 and Qt5, use the qmake from Qt4 or Qt5 to configure TEA with exact version of QT. The common solution is to make symlink to qmake from Qt5 and name it qmake5, then use qmake5 instead of the usual qmake.

2. If the context menus in TEA are not localized, install the qttranslations package from your distro's repository.

3. With cmake, there are no way to disable some TEA features manually - they will be compiled if TEA found the libs those needed.

/*
Basic snippet for Ubuntu users (Qt5 build) - run this from Terminal at the TEA source directory (unpacked):

sudo apt-get install g++ pkg-config
sudo apt-get install zlib1g-dev libaspell-dev libhunspell-dev
sudo apt-get install qt5-default qttools5-dev-tools
sudo apt-get install libqt5qml5 libqt5quick5 qtdeclarative5-dev
qmake
make
sudo make install


Snippet for Ubuntu users (Qt4 build):

sudo apt-get install g++ pkg-config
sudo apt-get install zlib1g-dev libaspell-dev libhunspell-dev
sudo apt-get install libqt4-dev qt4-dev-tools
qmake
make
sudo make install
*/


==02: NOTES FOR PACKAGE MAINTAINERS==

0. Thank you for packaging TEA!

1. Altough TEA has two home sites, it is better to use Github releases as the source:
https://github.com/psemiletov/tea-qt/archive/$pkgver.tar.gz
   
Please note, that TEA source dir after unpacking will be tea-qt-${pkgver}

2. TEA after the compilation is a single binary file (with embedded resources).

3. TEA supports 3 build systems:

  * qmake - the traditional one, good for Qt4-Win32-OS/2-Slackware builds. TEA's qmake project file is old and obscure. QML plugins are enabled by deafault, that is not wise.
  * cmake - good for Qt5 build, the reference one for TEA, has more options than meson support. I recommend to use cmake to build TEA package.
  * meson - I use it internally. Has no option to enable QML plugins.

4. For the qmake build, to override the default installation path (/usr/local, with binary at /usr/local/bin) use:

qmake PREFIX=your_path
make
make install

5. QML plugins. Altough you can enable it for cmake with cmake -DUSE_QML=True, or use qmake-based build, I hope you don't enable them, because starting from TEA 49, QML-support at TEA is frozen and unmaintained, and will be removed if no one use it.


==03: NOTE FOR UBUNTU USERS==

User defined hotkeys may not work due to Qt5 and Unity global menu feature. To remove global menu support in Qt5 apps, do

sudo apt-get autoremove appmenu-qt5

or, if you want to remove also GTK global menus, use:

sudo apt-get autoremove appmenu-gtk appmenu-gtk3 appmenu-qt5


==04: LICENSE NOTES==

TEA code is licensed under GPL V3 and, partially, as a Public Domain. TEA media (images, etc), manuals and translations are public domain. Note to contributors - please put your translations into the public domain or GPL.

==05: DONATE==

If you want to support TEA via donation, better give your support to the Ukrainian dog shelter Lyubas House - http://lyubas.pp.ua. There are lot of dogs with disabilities, and they need help more than TEA. To donate via PayPal, please see http://www.ukraineanimalrescue.org/#!lyubas-house/cxfj. Please specify "For Lyubas's House" in the comments of donation, because there are other projects uses that PayPal account.

Ежели вы хотите как-то поддержать разработку TEA денежно, лучше поддержите киевский приют для собак Дом Любчика - http://lyubas.pp.ua. Любчик - это пёс на инвалидной коляске. У него много друзей, которым всегда нужна помощь.
