]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
added "dev" tag to default setup
authorMike Bayer <mike_mp@zzzcomputing.com>
Sat, 26 Aug 2006 19:00:37 +0000 (19:00 +0000)
committerMike Bayer <mike_mp@zzzcomputing.com>
Sat, 26 Aug 2006 19:00:37 +0000 (19:00 +0000)
some extra README

README
README.unittests
setup.cfg [new file with mode: 0644]

diff --git a/README b/README
index 997b3528e7a69ce55a5cac0bc42a13157cefdcee..8c398b7c44d2be432d662018a79c7e89d5fc359f 100644 (file)
--- 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 !
        
index 9acb98ee1d68bc4363a167b800bf0f93fd4fb5f9..59e4dcf4a32bfc2e64594288899034cf6a88e80d 100644 (file)
@@ -1,5 +1,7 @@
 To run unit tests (assuming unix-style commandline, adjust as needed for windows):
 
+Python 2.4 or greater is required since the unit tests use decorators.
+
 cd into the SQLAlchemy distribution directory.
 
 Set up the PYTHONPATH:
diff --git a/setup.cfg b/setup.cfg
new file mode 100644 (file)
index 0000000..01bb954
--- /dev/null
+++ b/setup.cfg
@@ -0,0 +1,3 @@
+[egg_info]
+tag_build = dev
+tag_svn_revision = true