INSTALL

Installing FeatherPad from distro repositories is most recommended. The following instructions are for those who have some experience in compilation.

************************************
*   Compilation And Installation   *
************************************

To compile FeatherPad from its source, first install its build dependencies. In Debian-based systems, they are:

 * cmake
 * g++ >= 12
 * libx11-dev and libxext-dev (for X11)
 * qt6-base-dev (for Qt6)
 * qt6-svg-dev (for hard-coded SVG icons)
 * libhunspell-dev (for spell checking)
 * qt6-base-dev-tools (for localization)

In Arch-based systems, the required package are:

 * cmake
 * gcc (or gcc-multilib for multilib systems)
 * libx11 and libxext (for X11)
 * qt6-base (for Qt6)
 * qt6-svg (for hard-coded SVG icons)
 * hunspell (for spell checking)
 * qt6-tools (for localization)

In Red Hat based systems like Fedora:

 * cmake
 * gcc-c++
 * libX11-devel
 * libXext-devel
 * qt6-qtbase-devel
 * qt6-qtsvg-devel
 * hunspell-devel
 * qt6-qttools-devel

And, finally, in OpenSUSE:

 * cmake
 * gcc-c++
 * libX11-devel
 * libXext-devel
 * libqt6-qtbase-devel
 * libqt6-qtsvg-devel
 * hunspell-devel
 * libqt6-qttools-devel


NOTE: `pkgconfig` is required for finding Hunspell's version with cmake. Since it may be provided by more that one package in some distros, it is not listed above.

Then, open a terminal inside this folder and issue the following commands:

	mkdir build && cd build
	cmake ..
	make
	sudo make install

In some distros, you may need to be more explicit and use `cmake .. -DCMAKE_INSTALL_PREFIX=/usr` for installing FeatherPad under `/usr`, in contrast to `/usr/local`. The latter place may not be good in Linux distros and could cause troubles later.

*******************************
*   Compilation without X11   *
*******************************

If, for whatever reason, you do not want the X11 support, you could first turn on the option "WITHOUT_X11":

	cmake .. -DWITHOUT_X11=ON

The result will have all features except for virtual desktop awareness.

Please also note that, on Linux, FeatherPad works under Wayland and you do not need to disable its X11 support for that.

Compilation on Haiku OS or macOS does not require "WITHOUT_X11" either.

**********************************
*   Translation (Localization)   *
**********************************

The file 'featherpad/data/translations/featherpad.ts' can serve as the basis for GUI translation. The translated file should be saved in the same directory as "featherpad_LN.ts", where "LN" is the abbreviation for the target language, like "de", "fr", "ja_JP", etc.

If you have translated FeatherPad's GUI into your language, please make a "Pull Request" (PR) at https://github.com/tsujan/FeatherPad for your work to be merged into FeatherPad!