summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTres Seaver <tseaver@palladion.com>2006-04-04 14:50:06 +0000
committerTres Seaver <tseaver@palladion.com>2006-04-04 14:50:06 +0000
commit0cc7748c8603a93d26c3386c1b767801e98af9c3 (patch)
tree776790d0fa81c811cbf9c419f5e5b3314c096a81
parente9d2dbfe5db60425b662a06d22bd783d482c1141 (diff)
downloadzope-security-0cc7748c8603a93d26c3386c1b767801e98af9c3.tar.gz
Extend skeleton project.
-rw-r--r--CHANGES.txt32
-rw-r--r--INSTALL.txt83
-rw-r--r--README.txt37
-rw-r--r--setup.cfg.in (renamed from setup.cfg)0
4 files changed, 152 insertions, 0 deletions
diff --git a/CHANGES.txt b/CHANGES.txt
new file mode 100644
index 0000000..23eb0c5
--- /dev/null
+++ b/CHANGES.txt
@@ -0,0 +1,32 @@
+zope.XXX Package Changelog
+==========================
+
+zope.XXX version 3.2.1 (2006/03/26)
+-----------------------------------
+
+- Corresponds to the verison of the XXX package shipped as part of
+ the Zope 3.2.1 release.
+
+zope.XXX version 3.2.0 (2006/01/05)
+-----------------------------------
+
+- Corresponds to the verison of the XXX package shipped as part of
+ the Zope 3.2.0 release.
+
+zope.XXX version 3.1.0 (2005/10/03)
+-----------------------------------
+
+- Corresponds to the verison of the XXX package shipped as part of
+ the Zope 3.1.0 release.
+
+zope.XXX version 3.0.1 (2005/07/27)
+-----------------------------------
+
+- Corresponds to the verison of the XXX package shipped as part of
+ the Zope X3.0.1 release.
+
+zope.XXX version 3.0.0 (2004/11/07)
+-----------------------------------
+
+- Corresponds to the verison of the XXX package shipped as part of
+ the Zope X3.0.0 release.
diff --git a/INSTALL.txt b/INSTALL.txt
new file mode 100644
index 0000000..6b9bfbc
--- /dev/null
+++ b/INSTALL.txt
@@ -0,0 +1,83 @@
+Installing This Package
+=======================
+
+Prerequisites
+-------------
+
+The installation steps below assume that you have the cool new 'setuptools'
+package installed in your Python. Here is where to get it:
+
+ $ wget http://peak.telecommunity.com/dist/ez_setup.py
+ $ /path/to/your/python ez_setup.py # req. write access to 'site-packages'
+
+
+ - Docs for EasyInstall:
+ http://peak.telecommunity.com/DevCenter/EasyInstall
+
+ - Docs for setuptools:
+ http://peak.telecommunity.com/DevCenter/setuptools
+
+ - Docs for eggs:
+ http://peak.telecommunity.com/DevCenter/PythonEggs
+
+
+Installing a Development Checkout
+---------------------------------
+
+Check out the package from subversion:
+
+ $ svn co svn+ssh://svn.zope.org/repos/main/zope.XXX/trunk \
+ src/zope.XXX
+ $ cd src/zope.XXX
+
+Install it as a "devlopment egg" (which also installs its "hard"
+dependencies):
+
+ $ /path/to/your/python setup.py devel
+
+The installation of dependency eggs uses the 'setup.cfg' file in
+the checkout. You can supply '--find-links' on the command line to
+point it at a non-standard package repository.
+
+
+Running the Tests
+-----------------
+
+To test the package, you will also need the 'zope.testing' package, which
+can't (yet) be automatically installed. Eventually, you should be able to
+type:
+
+ $ /path/to/your/python setup.py test
+
+and have it install the "testing dependencies." Today, the workaround
+is to install it manually:
+
+ $ /path/to/easy_install --find-links="...." zope.testing
+
+You can then run the tests (finally) from the checkout directory:
+
+ $ /path/to/your/python test.py
+ Running:
+ .............
+ Ran 13 tests with 0 failures and 0 errors in 0.094 seconds.
+
+
+Installing a Source Distribution
+--------------------------------
+
+You can also install it from a source distribution:
+
+ $ /path/to/easy_install --find-links="...." -eb src zope.XXX
+ $ cd src/zope.XXX
+ $ /path/to/your/python setup.py devel
+
+
+Installing a Binary Egg
+-----------------------
+
+Install the package as a "binary egg" (which also installs its "hard"
+dependencies):
+
+ $ /path/to/easy_install --find-links="...." zope.XXX
+
+
diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..8b87742
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,37 @@
+zope.XXX Package Readme
+=======================
+
+Overview
+--------
+
+Lorem ipsum delorem.
+
+Changes
+-------
+
+See CHANGES.txt.
+
+Installation
+------------
+
+See INSTALL.txt.
+
+
+Developer Resources
+-------------------
+
+- Subversion browser:
+
+ http://svn.zope.org/zope.XXX/
+
+- Read-only Subversion checkout:
+
+ $ svn co svn://svn.zope.org/repos/main/zope.XXX/trunk
+
+- Writable Subversion checkout:
+
+ $ svn co svn://svn.zope.org/repos/main/zope.XXX/trunk
+
+- Note that the 'src/zope/XXX' package is acutally a 'svn:externals' link
+ to the corresponding package in the Zope3 trunk (or to a specific tag,
+ for released versions of the package).
diff --git a/setup.cfg b/setup.cfg.in
index bdfcfcc..bdfcfcc 100644
--- a/setup.cfg
+++ b/setup.cfg.in