-
Notifications
You must be signed in to change notification settings - Fork 23
/
INSTALL
80 lines (56 loc) · 2.82 KB
/
INSTALL
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
To compile FeatherNotes from its source, first install build dependencies. In Debian-based systems, they are:
* g++ >= 12
* libx11-dev and libxext-dev (for X11)
* qt6-base-dev (for Qt6)
* qt6-svg-dev (for hard-coded SVG icons)
* qt6-base-dev-tools (for localization)
* libhunspell-dev (for spell checking)
In Arch-based systems, the required package are:
* gcc (or gcc-multilib for multilib systems)
* libx11 and libxext (for X11)
* qt6-base (for Qt6)
* qt6-svg (for hard-coded SVG icons)
* qt6-tools (for localization)
* hunspell (for spell checking)
In Red Hat based systems like Fedora:
* gcc-c++
* libX11-devel
* libXext-devel
* qt6-qtbase-devel
* qt6-qtsvg-devel
* qt6-qttools-devel
* hunspell-devel (for spell checking)
And, finally, in OpenSUSE:
* gcc-c++
* libX11-devel
* libXext-devel
* libqt6-qtbase-devel
* libqt6-qtsvg-devel
* libqt6-qttools-devel
* hunspell-devel (for spell checking)
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 FeatherNotes under `/usr`, in contrast to `/usr/local`. The latter place may not be good in Linux distros and could cause troubles later.
************************************
* Compilation without Hunspell *
************************************
Under Linux and Unix, FeatherNotes supports spell checking with Hunspell, which is included in the compilation by default.
But if you do not want the spell checking support, you could first turn it off with:
cmake .. -DWITH_HUNSPELL=OFF
*******************************
* 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, FeatherNotes 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 'feathernotes/data/translations/feathernotes.ts' can serve as the basis for translation. The translated file should be saved in the same directory as "feathernotes_LN.ts", where "LN" is the abbreviation for the target language, like "de", "fr", etc.
If you have translated FeatherNotes's GUI into your language, please make a "Pull Request" (PR) at https://github.com/tsujan/FeatherNotes for your work to be merged into FeatherNotes!