From 4a0d6fc5d5255007c6748386d524247881ffd48a Mon Sep 17 00:00:00 2001 From: Marko Mattila Date: Wed, 10 Apr 2013 08:49:17 +0300 Subject: [PATCH] [nemo-tranfer-engine] Updated README file. --- README | 25 +++++++++++++++++-------- 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/README b/README index 75574cb..e474138 100644 --- a/README +++ b/README @@ -1,19 +1,28 @@ Nemo Transfer Engine -Simple engine for keeping track of transfers (sync, download, upload) and providing plugin mechanism for -share plugins. +Nemo Transfer Engine is an engine for sharing content and keeping track of sync, download and uploads. +This engine doesn't provide any UI specific components, but instead it makes possible to build e.g. +Transfer UI for displaying all the transfers (finished, failed, canceled or in progress) by using the +API it defines. -Transfer engine provides D-Bus API for managing the database and querying transfer information. +To create share plugins, Nemo Transfer Engine defines required interfaces, which each plugin must +implement. -Building: +For more details about API and implementing share plugins, generate docs according to instructions below. -qmake -make -Generating Docs: +Building using qmake: + +# qmake +# make + +Generating Docs to docs/html directory: make sure qdoc3 is installed and run: -make docs +# make docs + +Building using 'mb' script in Mer Platform SDK: +# mb build -t rpm/transfer-engine.spec