MINOR Replaced INSTALL, UPGRADING and ChangeLog files with a more consistent README

This commit is contained in:
Ingo Schommer 2011-10-19 09:11:52 +02:00
parent 4adccf7ca7
commit 1b90766e8b
4 changed files with 43 additions and 40 deletions

View File

@ -1 +0,0 @@
For a full change log, please visit http://open.silverstripe.org/wiki/ChangeLog.

19
INSTALL
View File

@ -1,19 +0,0 @@
Thanks for downloading SilverStripe CMS.
Simply extract the archive to a folder in a web-accessible location and visit the folder
in your web browser (which in turn runs index.php).
This will lead you through a web-based installation process.
Server Requirements
* PHP 5.0.4+ (5.2+ is recommended)
* MySQL 4.1+ (other databases are supported - details here: http://doc.silverstripe.com/doku.php?id=server-requirements)
* Apache or IIS 7.x
* More information on server requirements here: http://doc.silverstripe.com/doku.php?id=server-requirements
General documentation, tutorials:
* Wiki: http://doc.silverstripe.com/
* Tutorials: http://doc.silverstripe.org/doku.php?id=tutorials
Forum
* http://www.silverstripe.com/silverstripe-forum/

43
README.md Normal file
View File

@ -0,0 +1,43 @@
## Overview
Base project folder for a SilverStripe ([http://silverstripe.org](http://silverstripe.org)) installation. Requires additional modules to function:
* [`sapphire`](http://github.com/silverstripe/sapphire): Module including the base framework
* [`cms`](http://github.com/silverstripe/silverstripe-cms): Module including a Content Management System
* `themes/blackcandy` (optional)
## Server Requirements ##
See [doc.silverstripe.org](http://doc.silverstripe.org/sapphire/en/installation/server-requirements)
## Installation ##
See [installation on different platforms](http://doc.silverstripe.org/sapphire/en/installation/),
and [installation from source](http://doc.silverstripe.org/sapphire/en/installation/from-source).
## Links ##
* [Changelogs](http://doc.silverstripe.org/sapphire/en/changelogs/)
* [Bugtracker](http://open.silverstripe.org)
* [Forums](http://silverstripe.org/forums)
* [Developer Mailinglist](https://groups.google.com/forum/#!forum/silverstripe-dev)
## License ##
Copyright (c) 2007-2011, SilverStripe Limited - www.silverstripe.com
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
* Neither the name of SilverStripe nor the names of its contributors may be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE.

View File

@ -1,20 +0,0 @@
Usually upgrading your SilverStripe installation just means overwriting files
and updating your database-schema.
- Backup your database
- Backup your webroot
- Download the new release and uncompress it to a temporary folder
- With these folders: cms, sapphire, googlesitemaps
- Delete your existing folders
- Extract and replace folders from your download (leave modules
and your custom directories alone)
- Moving your current folders (rather than installing on top) means
you can undo the installation, and ensures if the new release has no
longer contains some files, these files won't be left behind, which otherwise
could cause bugs.
- Visit http://your.silverstripe.site/dev/build (This adds new
fields/tables to the database, and empties your template cache)
- Check if any modules (e.g. blog or forum) in your installation are compatible
and need to be upgraded as well
- Check if you need to adapt your code to changed APIs, see
http://doc.silverstripe.com/doku.php?id=upgrading