From: Cosimo Cecchi Date: Tue, 5 Aug 2008 09:38:44 +0000 (+0200) Subject: Update doc files for the release. X-Git-Tag: 0.1~1 X-Git-Url: https://repo.or.cz/w/mmediamanager.git/commitdiff_plain/565be970f87124ea90545b532120266085a6f8d3 Update doc files for the release. --- diff --git a/HACKING b/HACKING new file mode 100644 index 0000000..d51cde6 --- /dev/null +++ b/HACKING @@ -0,0 +1,27 @@ +Hacking on libmmanager +---------------------- + +The source tree is available in a GIT repository at repo.or.cz. +I will publish the tarballs of the releases in my private site +(http://anarki.lilik.it), but I plan to move to ftp.gnome.org one day. +I don't have a bug tracker yet, so right now you still have to ping me +manually on irc.gnome.org (cosimoc) or send me a mail (cosimoc@gnome.org) +if something goes wrong, but again, I plan to have something in +bugzilla.gnome.org for this. + +Coding style +------------ + +I use 2-spaces and no tabs for intentation. +K&R style for braces, and always use a brace also when the block is a +one-liner. +No C++ comments also. + +Submitting patches +------------------ + +In the remote case you want to send me a patch, please use git-format-patch, +git-diff, or anyway whatever I can apply with patch -p0 or patch -p1. +In case you really want to send me a patch, you will be my personal hero of the +day and if the patch isn't trivial, there are quite some chances I will offer +you a beer if we meet :) diff --git a/MAINTAINERS b/MAINTAINERS new file mode 100644 index 0000000..4c87532 --- /dev/null +++ b/MAINTAINERS @@ -0,0 +1,3 @@ +Cosimo Cecchi +Email: cosimoc@gnome.org +Userid: cosimoc diff --git a/NEWS b/NEWS index e69de29..380a4f9 100644 --- a/NEWS +++ b/NEWS @@ -0,0 +1,15 @@ +== libmmanager 0.0.1 (codename "Paris fever") == + +- First official release! +- libmmanager is quite complete. It still needs some async love and some + features which should be there, like attribute values validation. +- Right now I only implemented MMAttributeBaseManager, which can only handle + "uri" and "name". It should be very easy to add more attributes, but this + release is meant to be used only for testing. +- libmmanager-gtk is quite a proof of concept yet. Still, some parts are quite + usable, mostly the stores. More work to do on this for the next release. + Also, the MMGtkFilterBuilder is ugly! +- The release comes with many client tests (under test/clients) and a simple + fake application to test comunication between the library and an + application using it (under test/server). +- Enjoy and happy hacking :) diff --git a/README b/README index 758791c..47f8eb2 100644 --- a/README +++ b/README @@ -1 +1,21 @@ libmmanager, a Desktop wide manager library for multimedia applications. + +libmmanager is a library which aims to offer an unified API to access +multimedia application databases. +It offers two way of comunication between the library and the applications: +- .so (shared object) files +- DBus session bus. + +On top of libmmanager, there's libmmanager-gtk (which is really the thing you +might me interested in), which aims to offer a nice set of widgets to use +for querying and displaying results from the multimedia applications supporting +the library. + +libmmanager is written as a Google Summer of Code 2008 project by Cosimo Cecchi + and right now is still in alpha state: libmmanager is some +steps more mature than libmmanager-gtk, which is still quite a proof-of-concept +sketch of how things should and do work. :) + +If you're interested in contributing, please have a look at the items in TODO, +read the HACKING file and feel free to drop me a mail or contact me on +irc.gnome.org (cosimoc).