[Debtags-commits] [svn] r912 - in tagcoll/trunk: . debian

[Enrico Zini]

Author: enrico
Date: Sat Jun 18 15:19:23 2005
New Revision: 912

Added:
   tagcoll/trunk/DONE
Removed:
   tagcoll/trunk/TODO
Modified:
   tagcoll/trunk/README
   tagcoll/trunk/debian/docs
Log:
Restyled README merging in TODO and bumped version for release

Modified: tagcoll/trunk/README
==============================================================================
--- tagcoll/trunk/README	(original)
+++ tagcoll/trunk/README	Sat Jun 18 15:19:23 2005
@@ -1,31 +1,137 @@
-Quick README for tagcoll
+README for tagcoll 1.2
+======================
 
- * What is a tagged collection
+Functionality
+-------------
 
-Nothing special: a tagged collection is just a set of items in which each item
-is associated with a set of zero or more tags, in no particular order.
+A tagged collection is a set of items in which each item is associated with a
+set of zero or more tags, in no particular order.
 
-
- * Description:
+Or, more briefly, a collection of things with categories attached.
 
 tagcoll performs operations with tagged collections.  It has been written
 with the purpose of studying tagged collections and experiment with tagged
 collection algorithms.
 
-
- * Operations
-
 tagcoll comes with commandline help for a quick option summary and a complete
 manpage with documentation for all the switches and the format of input and
 output data.
  
 
- * Author
+What is in this release
+-----------------------
+
+Porting to a newer version of libtagcoll1.
+
+
+Compiling from the subversion repository
+----------------------------------------
+
+Additionally to the build-dependencies, you need to install ``libtool`` and
+``automake1.9`::
+
+  apt-get install libtool automake1.9
+  ./autogen.sh
+  ./configure
+  make
+
+The library uses GNU Libtool.  While this is very nice, it can be a pain when
+trying to debug a program. For that reason, compilation of shared libraries can
+be turned off by specifying the ``--disable-shared`` option to ``configure``.
+
+
+Resources
+---------
+
+  Website:
+
+    http://debtags.alioth.debian.org
+
+  Mailing lists:
+  
+    debtags-devel@lists.alioth.debian.org
+    http://lists.alioth.debian.org/mailman/listinfo/debtags-devel
+      Development and usage discussions
+  
+    debtags-commits@lists.alioth.debian.org
+    http://lists.alioth.debian.org/mailman/listinfo/debtags-commmits
+      Postings of subversion logs
+
+  Subversion repository:
+
+    http://svn.debian.org/viewcvs/debtags/libdebtags
+      Browse online
+    svn://svn.debian.org/debtags/libdebtags
+      Read-only access
+    svn+ssh://alioth.debian.org/svn/debtags/libdebtags
+      Write access
+
+  APT repository:
+
+    deb http://debtags.alioth.debian.org/debian unstable main
+
+
+Further stages of the development
+---------------------------------
+
+Development will now proceed by just tracking changes and features of
+libtagcoll1 to provide an up-to-date commandline interface to them.
+
+
 
-tagcoll has been written by Enrico Zini <enrico@debian.org> for the purpose of
-experimenting with tagged collections and related algorithms: all possible
-feedback and ideas are thus more than welcome.
+TODO-list items completed so far
+--------------------------------
+
+These are the TODO-list items completed so far::
+
+
+(older completed items are archived in the DONE file)
+
+
+
+TODO-list items being worked on
+-------------------------------
+
+These are the TODO-list items currently being worked on::
+
+
+
+Future TODO-list items
+----------------------
+
+These are the TODO-list items that are to be addressed in the future::
+
+ - Do a facet filter, to only get in packages with given facets.  It could be
+   used for example to prepare the data to then create a smart hierarchy using
+   only facets relevant to a given environment
+ - Have the related command accept a tagset, and not just a package name, as
+   the start of a search [ender]
+ - [hervé] perform some cleanup before building the .deb
+   > The problem is, it takes a lot of time for me to dwelve into the
+   > automake info files to find out how to add to the distclean target.
+   > Do you have some hint on where to look at?
+   CLEANFILES = *~ .*~ *.bak *.org gmon.out core \#*\# .\#*
+   in .am files. You can add that in a include file, included by every  
+   Makefile.am...
+   (it should be superseded by building on a fresh svn checkout)
+
+
+
+
+Discarded TODO-list items
+-------------------------
+
+These TODO-list items have been discarded::
+
+
+Useful resources
+----------------
+
+
+Author
+------
+
+Enrico Zini <enrico@debian.org>
 
 Erich Schubert and Hervé Eychenne have contributed a great deal of feedback and
 ideas.
-

Modified: tagcoll/trunk/debian/docs
==============================================================================
--- tagcoll/trunk/debian/docs	(original)
+++ tagcoll/trunk/debian/docs	Sat Jun 18 15:19:23 2005
@@ -1,4 +1,4 @@
 NEWS
 README
-TODO
+TONE
 doc/*