summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2006-08-26 19:00:37 +0000
committerMike Bayer <mike_mp@zzzcomputing.com>2006-08-26 19:00:37 +0000
commit5b8ab3e8abc704ee10ece0d4d3e93bf9164a9826 (patch)
tree89a4aa1cda96f9d65f94721fc256f70747037502 /README
parent7a15313c9e42bfcdd03b79a8edf3d0a7eb97d78d (diff)
downloadsqlalchemy-5b8ab3e8abc704ee10ece0d4d3e93bf9164a9826.tar.gz
added "dev" tag to default setup
some extra README
Diffstat (limited to 'README')
-rw-r--r--README17
1 files changed, 16 insertions, 1 deletions
diff --git a/README b/README
index 997b3528e..8c398b7c4 100644
--- a/README
+++ b/README
@@ -5,6 +5,21 @@ All licenses allow for non-commercial and commercial use.
To install:
python setup.py install
-
+
+SVN checkouts also inlcude setup.cfg file allowing setuptools to create
+an svn-tagged build.
+
+Documentation is available in HTML format in the ./doc/ directory.
+
+The "raw" format of the documentation is Markdown with a few extra syntaxes
+added in; those files are present in ./doc/build/content/.
+
+To fully generate the documentation into both Myghty and HTML format:
+
+ cd ./doc/build/
+ python genhtml.py
+
+Information running unit tests is in README.unittests.
+
good luck !