Skip to content
Permalink
Browse files
[nemo-tranfer-engine] More formatting for the README file.
  • Loading branch information
Marko Mattila committed Apr 10, 2013
1 parent 4a0d6fc commit f18aa680bd73b99719048695e3c5681c20dac357
Showing 1 changed file with 16 additions and 11 deletions.
27 README
@@ -1,27 +1,32 @@
Nemo Transfer Engine
--------------------

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.
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.

To create share plugins, Nemo Transfer Engine defines required interfaces, which each plugin must
implement.
To create share plugins, Nemo Transfer Engine defines required interfaces, which each plugin must
implement.

For more details about API and implementing share plugins, generate docs according to instructions below.
For more details about API and implementing share plugins, generate docs according to instructions below.


Building using qmake:
---------------------

# qmake
# make
# qmake
# make

Generating Docs to docs/html directory:
Generating Docs to docs/html directory:
---------------------------------------

make sure qdoc3 is installed and run:

# make docs

Building using 'mb' script in Mer Platform SDK:
Building RPMs using 'mb' script in Mer Platform SDK:
-----------------------------------------------

# mb build -t <your target name> rpm/transfer-engine.spec

0 comments on commit f18aa68

Please sign in to comment.