[Techne-dev-commit] SF.net SVN: techne-dev: [58] sandbox/tonit/techne.audio/readme

[<to...@us...>]

Revision: 58
          http://techne-dev.svn.sourceforge.net/techne-dev/?rev=58&view=rev
Author:   tonit
Date:     2007-02-13 13:07:45 -0800 (Tue, 13 Feb 2007)

Log Message:
-----------
this file explains the purpose, gives hints for build, package and deployment and gives a small todo list

Added Paths:
-----------
    sandbox/tonit/techne.audio/readme

Added: sandbox/tonit/techne.audio/readme
===================================================================
--- sandbox/tonit/techne.audio/readme	                        (rev 0)
+++ sandbox/tonit/techne.audio/readme	2007-02-13 21:07:45 UTC (rev 58)
@@ -0,0 +1,62 @@
+What is it ?
+==================
+its a set of osgi bundles. They all make up a family of related bundles but yet communicating over small 
+service interfaces.
+
+1. techne.audio.player
+This is the player. it provides the PlayerControl Service to the OSGi Service Registry.
+It depends in the javazoom library (already in place at the load directory of techne-env)
+
+It requires at least one registered techne.audio.player.MusicSource Service
+
+2. techne.audio.tui
+a felix shell extension providing the "audio" command.
+it requires a techne.audio.PlayerControl Service registered at the service registry.
+
+3. techne.audio.samplemusic
+Provides an implementation of techne.audio.player.MusicSource using an embedded mp3 track. 
+
+4. techne.audio.itunes
+Provides an implementation of techne.audio.player.MusicSource using a locally installed itunes music library.
+(not yet implemented.. but a cool part)
+
+How to build , package & deploy
+==================================
+- i am currently transfering this project to maven and the maven-bundle-plugin
+Compiling:
+---------------
+currently the actual compile is taken by eclipse.. (so you need to import this project into the IDE)
+
+Packaging:
+---------------
+use the bnd tool to build jars out of the .bnd files
+
+For example for a unix environment (cygwin should work i think..)
+0. Open a shell, go to the directory of this readme file
+1.(optional) make peters bnd.jar executable: 
+"alias bnd='java -jar <pathtoyourworkspace>/techne-env/lib/bnd-0.0.110.jar'"
+2. build the plugins:
+"bnd build techne.audio.player.bnd"
+"bnd build techne.audio.tui.bnd"
+"bnd build techne.audio.samplemusic.bnd"
+"bnd build techne.audio.itunes.bnd"
+done.
+
+Deploying
+---------------
+Load the jars like any ordinary bundle.
+Note: the techne.audio.tui requires felix.shell
+This kind of issue is going to be addressed here: http://issues.ops4j.org/jira/browse/BUNDLES-1?page=comments#action_10141
+
+Actually, the easiest way to play woth the services is using aQutes FileInstall Bundle:
+Just drop the generated jars into the load directory of your fileinstaller
+
+ToDo
+================================
+- convert build model to maven-bundle-plugin (use felix as a good sample)
+- define metadata to make the bundles more intelligent (far)
+- implement the itunes support (wanna have..)
+
+
+--Toni Menzel / 12th of february 2007
+


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.