summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorSylvain Th?nault <sylvain.thenault@logilab.fr>2010-08-26 09:28:53 +0200
committerSylvain Th?nault <sylvain.thenault@logilab.fr>2010-08-26 09:28:53 +0200
commit1061c4f70518058423a45f86829bae5084d9e66e (patch)
tree4b8ca80dcda0fc4c884e0a37855fba94047271a4 /README
parentef88b7116ead50188dba9d6543f7b03a6ea3b796 (diff)
downloadlogilab-common-1061c4f70518058423a45f86829bae5084d9e66e.tar.gz
more README fixes
Diffstat (limited to 'README')
-rw-r--r--README32
1 files changed, 19 insertions, 13 deletions
diff --git a/README b/README
index 528fab4..ea480b2 100644
--- a/README
+++ b/README
@@ -4,25 +4,21 @@ Logilab's common library
What's this ?
-------------
-This package contains some modules used by differents Logilab's
-projects.
+This package contains some modules used by differents Logilab's projects.
It is released under the GNU Public License.
-There is no documentation available yet but the source code should be
-clean and well documented.
+There is no documentation available yet but the source code should be clean and
+well documented.
Designed to ease:
* handling command line options and configuration files
* writing interactive command line tools
-* manipulation files and character strings
-* interfacing to OmniORB
-* running unit tests
-* manipulating tree structures
+* manipulation of files and character strings
+* manipulation of common structures such as graph, tree, and pattern such as visitor
* generating text and HTML reports
-* logging
-* parsing XML processing instructions
+* accessing some external libraries such as OmniORB_, Pyro_...
* more...
@@ -59,7 +55,7 @@ Modules providing high-level features
* `configuration`, some classes to handle unified configuration from both
command line (using optparse) and configuration file (using ConfigParser).
-* `dbf`, read Visual Fox Pro DBF files
+* `dbf`, read Visual Fox Pro DBF files.
* `proc`, interface to Linux /proc.
@@ -125,7 +121,7 @@ Modules extending some external modules
* `corbautils`, useful functions for use with the OmniORB_ CORBA library.
-* `hg`, some mercurial_ utility functions.
+* `hg`, some Mercurial_ utility functions.
* `pdf_ext`, pdf and fdf file manipulations, with pdftk.
@@ -145,7 +141,7 @@ versions:
* `testlib`: use `unittest2`_ instead
* `pytest`: use `discover`_ instead
-* `interface`: use `zope.interface` if you really want this
+* `interface`: use `zope.interface`_ if you really want this
* `table`, `xmlutils`: is that used?
* `sphinxutils`: we won't go that way imo (i == syt)
@@ -179,3 +175,13 @@ http://lists.logilab.org/mailman/listinfo/python-projects
Archives are available at
http://lists.logilab.org/pipermail/python-projects/
+
+
+.. _Pyro: http://pyro.sourceforge.net/
+.. _OmniORB: http://omniorb.sourceforge.net/
+.. _Mercurial: http://mercurial.selenic.com
+.. _Sphinx: http://sphinx.pocoo.org/
+.. _`logilab.database`: http://www.logilab.org/project/logilab-database/
+.. _`unittest2`: http://pypi.python.org/pypi/unittest2
+.. _`discover`: http://pypi.python.org/pypi/discover
+.. _`zope.interface`: http://pypi.python.org/pypi/zope.interface