Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features.

BUG:215923


git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdemultimedia@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da

1 files changed, 28 insertions, 0 deletions

diff --git a/arts/modules/README.modules b/arts/modules/README.modules
new file mode 100644
index 00000000..7113b3a9
--- /dev/null
+++ b/arts/modules/README.modules
@@ -0,0 +1,28 @@
+		     How to add a new aRts module
+
+(This will eventually go into the aRts documentation).
+
+To add a new module "foo" to aRts:
+
+1. Add a new interface to artsmodules.idl defining the
+   module's input and output parameters.
+
+2. Implement the new module in a new source file foo_impl.cc
+
+3. Add foo_impl.cc to the list of libartsmodules_la_SOURCES in
+   Makefile.am.
+
+4. Create a new file mcopclass/foo.mcopclass
+
+5. Add foo.mcopclass to the list of mcopclass_DATA in
+   mcopclass/Makefile.am.
+
+6. Do a clean build and install and debug and test your new module.
+       (make clean && make && make install)
+       killall artsd ; artsd &
+
+7. Update the TODO file with the status of the new module.
+
+
+Jeff Tranter
+tranter@pobox.com