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