Skip to content

Commit

Permalink
[nemo-tranfer-engine] Updated README file.
Browse files Browse the repository at this point in the history
  • Loading branch information
Marko Mattila committed Apr 10, 2013
1 parent a0fbc2b commit 4a0d6fc
Showing 1 changed file with 17 additions and 8 deletions.
25 changes: 17 additions & 8 deletions 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 <your target name> rpm/transfer-engine.spec


0 comments on commit 4a0d6fc

Please sign in to comment.