summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJason Kirtland <jek@discorporate.us>2008-01-05 21:46:08 +0000
committerJason Kirtland <jek@discorporate.us>2008-01-05 21:46:08 +0000
commit40efd3a9c140ee199686becc08bfd7d7bb021ade (patch)
tree1d918c5970e001b79feef26f19c120ac33a9291b
parent35f7a0b594e189bf765b866ae1e4632088a4d52f (diff)
downloadsqlalchemy-40efd3a9c140ee199686becc08bfd7d7bb021ade.tar.gz
Updates
-rw-r--r--README54
1 files changed, 43 insertions, 11 deletions
diff --git a/README b/README
index 881ef4c70..28f843e99 100644
--- a/README
+++ b/README
@@ -1,17 +1,49 @@
-SQLAlchemy is licensed under an MIT-style license (see LICENSE).
-Other incorporated projects may be licensed under different licenses.
-All licenses allow for non-commercial and commercial use.
+SQLAlchemy
+++++++++++
-To install:
+The Python SQL Toolkit and Object Relational Mapper
- python setup.py install
+Requirements
+------------
-SVN checkouts also include setup.cfg file allowing setuptools to create
-an svn-tagged build.
+SQLAlchemy requires Python 2.3 or higher. One or more DB-API implementations
+are also required for database access. See docs/intro.html for more
+information on supported DB-API implementations.
-Documentation is available in HTML format in the ./doc/ directory.
+Installing
+----------
-Information running unit tests is in README.unittests.
+To install::
-good luck !
-
+ python setup.py install
+
+To use without installation, include the ``lib`` directory in your Python
+path.
+
+Package Contents
+----------------
+
+ doc/
+ HTML documentation, including tutorials and API reference.
+
+ examples/
+ Fully commented and executable implementations for a variety of tasks.
+
+ lib/
+ SQLAlchemy.
+
+ test/
+ Unit tests for SQLAlchemy. See ``README.unittests`` for more
+ information.
+
+Help
+----
+
+Mailing lists, wiki, and more are available on-line at
+http://www.sqlalchemy.org.
+
+License
+-------
+
+SQLAlchemy is distributed under the `MIT license
+<http://www.opensource.org/licenses/mit-license.php>`_.