# Join Us!

So you want to participate in developing Kate?
Great!
The project is always in need of helping hands.

If you need pointers, please visit the following pages:

* Central hub for information around Kate development: Just head to our website [kate-editor.org](https://kate-editor.org/).

* How to compile Kate on your machine? Read our [Build it!](https://kate-editor.org/build-it/) tutorial.

* How to help out with the project? See our [Join Us!](https://kate-editor.org/join-us/) page.

## Licensing

Contributions to kate.git shall be licensed under [LGPLv2+](LICENSES/LGPL-2.0-or-later.txt) or [MIT](LICENSES/MIT.txt).

All files shall contain a proper "SPDX-License-Identifier: LGPL-2.0-or-later" or "SPDX-License-Identifier: MIT" identifier inside a header like:

```cpp
/*
    SPDX-FileCopyrightText: 2021 Christoph Cullmann <cullmann@kde.org>

    SPDX-License-Identifier: LGPL-2.0-or-later
*/
```

```cpp
/*
    SPDX-FileCopyrightText: 2021 Christoph Cullmann <cullmann@kde.org>

    SPDX-License-Identifier: MIT
*/
```

# kate.git content

## kate

The **kate** directory contains the Kate application sources.

Kate is using KUserFeedback for telemetry starting with release 20.04.

For details of the opt-in send information, see https://community.kde.org/Telemetry_Use

## kwrite

The **kwrite** directory contains the KWrite application sources.

## addons

The **addons** directory contains in sub-directories the sources of all bundled plugins.
These plugins are not only used by Kate itself but other KTextEditor compatible applications, like KDevelop.

## doc

The **doc** directory contains the Kate, KWrite & KatePart manuals.

## shared

The **shared** directory contains common code parts needed by the applications & plugins.
This avoids needless code duplication.
This is purely internal, no libraries/headers are installed, this is meant to be just consumed inside this repository.

## LICENSES

The **LICENSES** directory contains the license files as referenced in the individual source files.
For any used **SPDX-License-Identifier** the matching license should be located there.
