pim/zanshin/README.md

0001 # Zanshin
0002
0003 A Getting Things Done application which aims at getting your mind like water.
0004
0005 > Zanshin is a state of awareness, of relaxed alertness, in Japanese martial arts. A literal translation of zanshin is "remaining mind". ([Extract from Wikipedia](https://en.wikipedia.org/wiki/Zanshin))
0006
0007 ## Contributing
0008
0009 #### Documentation
0010 - How to start contributing to KDE: https://community.kde.org/Get_Involved/development.
0011 - Check out [HACKING](https://invent.kde.org/pim/zanshin/-/blob/master/HACKING).
0012 - Talks that will help understand the code base and how to work with it:
0013         - [KDE Craftsmen](https://mirror.kumi.systems/kde/files/akademy/2014/videos/KDE_Craftsmen_-_Kevin_Ottens.webm)
0014         - [Agile to the Rescue](https://mirror.kumi.systems/kde/files/akademy/2014/videos/Agile_to_the_Rescue_-_Kevin_Ottens.webm)
0015                 - There is an excelent free EPUB that introduces DDD (mentioned in the talk): [Domain Driven Design Quickly  by Abel Avram and Floyd Marinescu](https://www.infoq.com/minibooks/domain-driven-design-quickly/).
0016         - [Rebooting Zanshin](https://mirror.kumi.systems/kde/files/akademy/2014/videos/Rebooting_Zanshin_-_Kevin_Ottens.webm)
0017         - [Do As I Say, Not As I Do: Or is it the Other Way Around?](https://youtu.be/dgV_hGoOjiM)
0018
0019
0020 #### Dependencies
0021
0022 - Make sure to have Qt > 6.4, Akonadi, AkonadiCalendar, KontactInterface, Runner, WindowSystem, I18n.
0023         - For openSUSE Tumbleweed users:
0024                 ```sh
0025                 $ zypper in akonadi-server-devel \
0026                 akonadi-calendar-devel akonadi-contact-devel \
0027                 kontactinterface-devel \
0028                 krunner-devel \
0029                 kwindowsystem-devel \
0030                 ki18n-devel
0031                 ```
0032
0033 - Alternatively you can try [kdesrc-build](https://community.kde.org/Get_Involved/development) or [KDE PIM Docker image for development](https://community.kde.org/KDE_PIM/Docker).
0034
0035 #### Issues and TO DO
0036
0037 - Check the [issue tracker](https://invent.kde.org/pim/zanshin/-/issues).
0038 - Search in the [KDE Bugtracking System](https://bugs.kde.org/buglist.cgi?quicksearch=zanshin).
0039
0040 If you have any questions, see how to get in touch at [https://community.kde.org/KDE_PIM/Development](https://community.kde.org/KDE_PIM/Development#Additional_information).