README.md 1.59 KB
Newer Older
1
2
<!--
    SPDX-FileCopyrightText: 2020 Dimitris Kardarakos <dimkard@posteo.net>
Devin Lin's avatar
Devin Lin committed
3
    SPDX-FileCopyrightText: 2022 Devin Lin <devin@kde.org>
4
5
    SPDX-License-Identifier: CC-BY-SA-4.0
-->
Devin Lin's avatar
Devin Lin committed
6
# Calindori <img src="logo.png" width="40"/> 
Dimitris Kardarakos's avatar
Dimitris Kardarakos committed
7

Devin Lin's avatar
Devin Lin committed
8
9
10
11
12
13
14
Calendar application for Plasma Mobile.

## Links

* Project page: https://invent.kde.org/plasma-mobile/calindori
* File an issue: https://invent.kde.org/plasma-mobile/calindori/-/issues
* Development channel: https://matrix.to/#/#plasmamobile:matrix.org
Dimitris Kardarakos's avatar
Dimitris Kardarakos committed
15

16
## Features
17

18
19
20
21
22
23
24
25
26
27
28
29
Calindori is a touch friendly calendar application. It has been designed for mobile devices but it can also run on desktop environments. It offers:

* Monthly agenda
* Multiple calendars
* Event management
* Task management
* Calendar import

![](screenshots/calindori_screenshot.png)

The calendars that the application handles follow the [ical](https://tools.ietf.org/html/rfc5545) standard.

Devin Lin's avatar
Devin Lin committed
30
It is a lighter alternative to [Kalendar](https://invent.kde.org/pim/kalendar), as it does not have a dependence on Akonadi.
31
32

## Build
Dimitris Kardarakos's avatar
Dimitris Kardarakos committed
33

34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
To build Calindori from source on Linux, execute the below commands.

### Compile

```
git clone https://invent.kde.org/kde/calindori.git
cd calindori
mkdir build
cd build
cmake ..
make -j$(nproc)
```

#### Run

```
bin/calindori
```

*To simulate Plasma Mobile user experience:*

```
Devin Lin's avatar
Devin Lin committed
56
QT_QUICK_CONTROLS_MOBILE=true bin/calindori
57
58
59
60
61
62
63
64
```

#### Install

```
sudo make install
```

Devin Lin's avatar
Devin Lin committed
65
66
67
### Android

The nightly build of Calindori for Android can be found in the F-Droid instance of KDE. You can add the repository following these [instructions](https://community.kde.org/Android/FDroid) and install Calindori.