forget the past.

forget the past.

1 files changed, 52 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 00000000..4755e73e
--- /dev/null
+++ b/README
@@ -0,0 +1,52 @@
+ASTNG
+=====
+
+What's this ?
+-------------
+
+The aim of this module is to provide a common base representation of
+python source code for projects such as pychecker, pyreverse,
+pylint... Well, actually the development of this library is essentialy
+governed by pylint's needs.
+
+It extends class defined in the compiler.ast [1] module with some
+additional methods and attributes. Instance attributes are added by a
+builder object, which can either generate extended ast (let's call
+them astng ;) by visiting an existant ast tree or by inspecting living
+object. Methods are added by monkey patching ast classes.
+
+Main modules are:
+
+* nodes and scoped_nodes for more information about methods and
+  attributes added to different node classes
+
+* the manager contains a high level object to get astng trees from
+  source files and living objects. It maintains a cache of previously
+  constructed tree for quick access
+
+* builder contains the class responsible to build astng trees
+
+
+Notice
+------
+This package has been extracted from the logilab-common package, which
+will be kept for some time for backward compatibility but will no
+longer be maintained. 
+
+
+Installation
+------------
+
+Extract the tarball, jump into the created directory and run ::
+
+	python setup.py install
+
+For installation options, see ::
+
+	python setup.py install --help
+
+
+If you have any questions, please mail devel@logilab.fr for support. 
+
+Sylvain Thénault
+Oct 21, 2005