-
Sample readme1
last modified May 2 by vedawms
Provided courtesy of Jonathan Wilde (speedbreeze).
Important things to note: Under dependences, there is no need to specify Zope or any of the python-related tools like setuptools. However, if your site uses the tableless product, it might be good to call that out. Also, under installation, installation instructions do belong in the install.txt. Remember to beef up that file to explain how to install your product if you are also releasing it as source code. The install.txt already does a pretty good job of explaining how to install a product as an egg.
Relic Readme
__________________________________________________________
Table of Contents
1. Overview
2. Authors & Contributors
3. Dependencies
4. Installation
5. Customization
6. Support
7. License
1. Overview
Relic is a light-colored three-column theme for Plone 3.x. It
has a very light background and has very easy-to-read text. It
is perfect for any website that wants a minimalist look. It
also has a large, customizable image header. The original Relic
web template that this Plone theme was based off of was created
by by Kevin Cannon.
__________________________________________________________
2. Authors & Contributors
* Jonathan Wilde <http://www.speedbreeze.com>
Ported template to Plone 3.x.
* Kevin Cannon
Created the original Relic web template.
__________________________________________________________
3. Dependencies
The following are required to use this theme:
* Zope
* Plone 3.x
* SetupTools
__________________________________________________________
4. Installation
The docs/INSTALL.txt file contains all installation
instructions for this theme.
__________________________________________________________
5. Customization
This theme contains a customizable image header. It is
contained in the plonetheme/relic/browser/images folder. It is
and must be named header.jpg in order for this theme to
recognize it. The image should measure 150 pixels high to fill
up all of the header. You can make the header as wide as you
want--it will be centered in the header. It is recommended,
though, to make the image at least 1024 pixels wide so that it
fills up the entire header space.
__________________________________________________________
6. Support
For support with this theme, you can contact a Plone person,
the Plone mailing lists, or ask for help in the Plone IRC
channel (#plone).
__________________________________________________________
7. License
GNU General Public License v2
For full copyright information regarding this package, see
docs/LICENSE.txt.