From 5b8ab3e8abc704ee10ece0d4d3e93bf9164a9826 Mon Sep 17 00:00:00 2001 From: Mike Bayer Date: Sat, 26 Aug 2006 19:00:37 +0000 Subject: [PATCH] added "dev" tag to default setup some extra README --- README | 17 ++++++++++++++++- README.unittests | 2 ++ setup.cfg | 3 +++ 3 files changed, 21 insertions(+), 1 deletion(-) create mode 100644 setup.cfg diff --git a/README b/README index 997b3528e7..8c398b7c44 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 ! diff --git a/README.unittests b/README.unittests index 9acb98ee1d..59e4dcf4a3 100644 --- a/README.unittests +++ b/README.unittests @@ -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 index 0000000000..01bb954499 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,3 @@ +[egg_info] +tag_build = dev +tag_svn_revision = true -- 2.47.2