summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e4a94a0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
1# Sink
2
3Sink is a data access layer handling synchronization, caching and indexing.
4
5To build it's documentation please run the builddocs.sh script or see the docs/ subdirectory.
6
7Discussion of the code should be done on the kde-pim at kde.org mailing list
8or in #kontact on IRC.
9
10Note that all feature development should happen in feature branches, and that
11the mainline development branch is "develop". Master is for releases. It is
12recommended (though not required) to use the "git flow" tools to make branched
13development easy (and easy for others to coordinate with):
14
15 https://github.com/nvie/gitflow
16
17For further information see:
18
19 https://phabricator.kde.org/project/view/5/
20