Changeset 30

Timestamp:

08/30/05 12:57:43 (8 years ago)

Author:

xi

Message:

Final touches before the release.

File:

• trunk/README.txt (modified) (7 diffs)

trunk/README.txt

@@ -22 +22 @@
 
 PySyck_ is aimed to update the current Python bindings for Syck. The new
-bindings will provide wrappers for the Syck emitter and give access to the bare
-Parser tree. Hopefully it will not leak memory as well.
+bindings provide a wrapper for the Syck emitter and give access to YAML
+representation graphs. Hopefully it will not leak memory as well.
 
 PySyck_ may be used for various tasks, in particular, as a replacement of the
@@ -45 +45 @@
 ============
 
-PySyck requires Syck version 0.55 or higher. If you install it from source, unpack
-the source tarball and type::
+Please note that Syck 0.55 or higher must be installed. If you install PySyck
+from source, unpack the source tarball and type::
 
   $ python setup.py install
@@ -56 +56 @@
 =====
 
-The documentation is still incomplete. See `the source code`_ for more details.
+The documentation is still rough and incomplete. See `the source code`_ for
+more information.
 
 .. _the source code: http://trac.xitology.org/pysyck/browser/
@@ -104 +105 @@
 ``!python/object:...``, ``!python/new:...``, and ``!python/apply:...`` are used
 for constructing Python functions, classes, and objects. See the sections `Use
-Python-specific tags in a YAML document`_ and `Use Python-specific tags to
+Python-specific tags in YAML documents`_ and `Use Python-specific tags to
 construct Python objects`_ for some examples.
 
@@ -188 +189 @@
   >>> dump_documents(objects, output)
 
-Get a representation tree of a YAML document
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Construct a representation tree of a YAML document
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 ::
@@ -238 +239 @@
   >>> print dump(node)
 
-Use Python-specific tags in a YAML document
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Use Python-specific tags in YAML documents
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 ::
@@ -874 +875 @@
 =======
 
-* PySyck-0.55.1 (2005-08-..): Initial release.
+* PySyck-0.55.1 (2005-08-30): Initial release.