Warning, /utilities/kate/README.md is written in an unsupported language. File is not indexed.
0001 # Kate 0002 0003 Modern text editor built on the KDE Frameworks and Qt. 0004 0005  0006 0007 ## Join Us! 0008 0009 So you want to participate in developing Kate? 0010 Great! 0011 The project is always in need of helping hands. 0012 0013 If you need pointers, please visit the following pages: 0014 0015 * Central hub for information around Kate development: Just head to our website [kate-editor.org](https://kate-editor.org/). 0016 0017 * How to compile Kate on your machine? Read our [Build it!](https://kate-editor.org/build-it/) tutorial. 0018 0019 * How to help out with the project? See our [Join Us!](https://kate-editor.org/join-us/) page. 0020 0021 ## Licensing 0022 0023 Contributions to kate.git shall be licensed under [LGPLv2+](LICENSES/LGPL-2.0-or-later.txt) or [MIT](LICENSES/MIT.txt). 0024 0025 All files shall contain a proper "SPDX-License-Identifier: LGPL-2.0-or-later" or "SPDX-License-Identifier: MIT" identifier inside a header like: 0026 0027 ```cpp 0028 /* 0029 SPDX-FileCopyrightText: 2021 Christoph Cullmann <cullmann@kde.org> 0030 0031 SPDX-License-Identifier: LGPL-2.0-or-later 0032 */ 0033 ``` 0034 0035 ```cpp 0036 /* 0037 SPDX-FileCopyrightText: 2021 Christoph Cullmann <cullmann@kde.org> 0038 0039 SPDX-License-Identifier: MIT 0040 */ 0041 ``` 0042 0043 ## kate.git content 0044 0045 ### apps 0046 0047 The apps folder contains both the Kate and KWrite applications itself and their shared implementation. 0048 0049 #### apps/lib 0050 0051 The **apps/lib** directory contains the shared sources of the Kate and KWrite applications. 0052 0053 Close to everything beside the main functions of the two applications is implemented there. 0054 0055 This is installed a shared library kateprivate that can be used by addons, too. 0056 The library isn't BC over releases, no headers to use it are installed to the system. 0057 0058 #### apps/kate 0059 0060 The **apps/kate** directory contains the Kate application sources. 0061 0062 Kate is using KUserFeedback for telemetry starting with release 20.04. 0063 0064 For details of the opt-in send information, see https://community.kde.org/Telemetry_Use 0065 0066 #### apps/kwrite 0067 0068 The **apps/kwrite** directory contains the KWrite application sources. 0069 0070 KWrite is using KUserFeedback for telemetry starting with release 22.08. 0071 0072 For details of the opt-in send information, see https://community.kde.org/Telemetry_Use 0073 0074 ### addons 0075 0076 The **addons** directory contains in sub-directories the sources of all bundled plugins. 0077 These plugins are not only used by Kate itself but other KTextEditor compatible applications, like KDevelop. 0078 0079 ### doc 0080 0081 The **doc** directory contains the Kate, KWrite & KatePart manuals. 0082 0083 ### LICENSES 0084 0085 The **LICENSES** directory contains the license files as referenced in the individual source files. 0086 For any used **SPDX-License-Identifier** the matching license should be located there. 0087 0088 ## Kate's Mascot: Kate the Cyber Woodpecker 0089 0090 Kate's mascot, Kate the Cyber Woodpecker, was designed by [Tyson Tan](https://www.tysontan.com/). 0091 0092 More details can be found on our [mascot page](https://kate-editor.org/mascot/). 0093 0094 