From beff739e193cf643b28f4c17ab56b366f5d5d376 Mon Sep 17 00:00:00 2001 From: Christian Mollekopf Date: Tue, 2 Feb 2016 16:32:31 +0100 Subject: Updated the README --- README | 19 ------------------- README.md | 20 ++++++++++++++++++++ 2 files changed, 20 insertions(+), 19 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index 4ab63c6..0000000 --- a/README +++ /dev/null @@ -1,19 +0,0 @@ -This repository contains a draft of a possible successor to Akonadi 1. - -It is currently entirely experimental and should not be considered a definite -replacement for Akonadi 1 at this point in time. - -Discussion of the code should be done on the kde-pim at kde.org mailing list -or in #kontact on IRC. - -Note that all feature development should happen in feature branches, and that -the mainline development branch is "develop". Master is for releases. It is -recommended (though not required) to use the "git flow" tools to make branched -development easy (and easy for others to coordinate with): - - https://github.com/nvie/gitflow - -You can find information about the overall design here: - - https://community.kde.org/KDE_PIM/Akonadi_Next - diff --git a/README.md b/README.md new file mode 100644 index 0000000..e4a94a0 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# Sink + +Sink is a data access layer handling synchronization, caching and indexing. + +To build it's documentation please run the builddocs.sh script or see the docs/ subdirectory. + +Discussion of the code should be done on the kde-pim at kde.org mailing list +or in #kontact on IRC. + +Note that all feature development should happen in feature branches, and that +the mainline development branch is "develop". Master is for releases. It is +recommended (though not required) to use the "git flow" tools to make branched +development easy (and easy for others to coordinate with): + + https://github.com/nvie/gitflow + +For further information see: + + https://phabricator.kde.org/project/view/5/ + -- cgit v1.2.3