tea-qt  50.1.0
About: TEA is a GTK-based text editor for UNIX-like systems and Windows (supporting HTML editing).
  Fossies Dox: tea-qt-50.1.0.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

tea-qt Documentation

Some Fossies usage hints in advance:

  1. To see the Doxygen generated documentation please click on one of the items in the steelblue colored "quick index" bar above or use the side panel at the left which displays a hierarchical tree-like index structure and is adjustable in width.
  2. If you want to search for something by keyword rather than browse for it you can use the client side search facility (using Javascript and DHTML) that provides live searching, i.e. the search results are presented and adapted as you type in the Search input field at the top right.
  3. Doxygen doesn't incorporate all member files but just a definable subset (basically the main project source code files that are written in a supported language). So to search and browse all member files you may visit the Fossies
  4. tea-qt-50.1.0.tar.gz contents page and use the Fossies standard member browsing features (also with source code highlighting and additionally with optional code folding).
README
===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://t.me/teaqt
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


Which build system you should use?

Use qmake for old distros and Windows.
Use meson or cmake for modern distros. cmake is the mainline build system for TEA. meson is almost the same, but builds TEA without the printer support.

 
01.01 CMAKE

If you want to build and install TEA with cmake + make, run at the TEA 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

By default, cmake builds TEA without some features: QML, printer and aspell support, libpoppler and djvuapi. To enable them, use from the build directory:

cmake .. -DUSE_ASPELL=ON -DUSE_PRINTER=ON -DUSE_PDF=ON -DUSE_DJVU=ON -DUSE_QML=ON 


01.02 MESON

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

To enable PDF and DJVU text extraction support use, and Aspell support (disabled by default as well as the printing support):

mkdir b
meson b
meson configure -Dpdf=enabled -Ddjvu=enabled -Daspell=enabled b
cd b
ninja
ninja install


01.03 QMAKE

With qmake to build 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 or qt-translations package from your distro's repository.


/*
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. I recommend to use cmake to build TEA package.
  * meson - I use it internally. Has no option to enable QML plugins and does not have the printer support.

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=ON, 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==


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