Commits

Mike Bayer committed 5b8ab3e

added "dev" tag to default setup
some extra README

  • Participants
  • Parent commits 7a15313

Comments (0)

Files changed (3)

 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 !
 	

File README.unittests

 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:
+[egg_info]
+tag_build = dev
+tag_svn_revision = true