diff --git a/README b/README index e474138..4d3198f 100644 --- a/README +++ b/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 rpm/transfer-engine.spec