[TASK] Updated README / INSTALL / NEWS files 90/25490/4
authorErnesto Baschny <ernst@cron-it.de>
Sat, 16 Nov 2013 16:54:13 +0000 (17:54 +0100)
committerErnesto Baschny <ernst@cron-it.de>
Wed, 20 Nov 2013 12:36:01 +0000 (13:36 +0100)
* Added README.md (which was formerly part of the individual
  distributions)
* Transformed the text into markdown for nice visualisation i.e.
  on Github
* Rewritten the installation steps
* Rewritten the system requirements

Releases: 6.2
Resolves: #53745
Change-Id: I293bde1a046e9f7c712d5d8d9cc13138a303efc2
Reviewed-on: https://review.typo3.org/25490
Reviewed-by: Michael Stucki
Tested-by: Michael Stucki
Reviewed-by: Wouter Wolters
Tested-by: Wouter Wolters
Reviewed-by: Markus Klein
Tested-by: Markus Klein
Reviewed-by: Ernesto Baschny
Tested-by: Ernesto Baschny
INSTALL.md [new file with mode: 0644]
INSTALL.txt [deleted file]
NEWS.md [new file with mode: 0644]
NEWS.txt [deleted file]
README.md [new file with mode: 0644]

diff --git a/INSTALL.md b/INSTALL.md
new file mode 100644 (file)
index 0000000..f5ea6e9
--- /dev/null
@@ -0,0 +1,272 @@
+INSTALLING TYPO3
+================
+
+TYPO3 is an open source PHP based web content management system released
+under the GNU GPL. TYPO3 is copyright (c) 1999-2013 by Kasper Skaarhoj.
+
+This document describes:
+
+* System requirements for TYPO3
+* Installation routine
+* Upgrade routine
+
+Client browser support
+----------------------
+
+The TYPO3 backend is accessed through a web browser. TYPO3 CMS 6.2 LTS
+supports the following web browsers:
+
+* Internet Explorer 8 and later
+* Google Chrome (Windows, MacOS, Linux)
+* Firefox (Windows, MacOS, Linux)
+* Safari on MacOS
+* and other compatible modern browsers
+
+Server system requirements
+--------------------------
+
+TYPO3 requires a web server with a PHP environment and a database. The minimum
+system requirements for running TYPO3 CMS 6.2 LTS are:
+
+* Webserver capable of running PHP applications (Apache, Nginx, IIS or other)
+* PHP >5.3.7 up to 5.5 (PHP 5.4 or later recommended)
+* MySQL 5.1 up to 5.6 or compatible
+* more than 200 MB of disk space
+
+### PHP environment
+
+* memory_limit set to at least 64M
+* max_execution_time set to at least 30s (240s recommended)
+* register_globals disabled
+* disabled safe_mode (not supported)
+* disabled magic_quotes (not supported)
+* AllowOverride in the Apache configuration includes "Indexes" and "FileInfo"
+  (see FAQ below)
+
+### PHP required extensions
+
+Your PHP needs to support the following extensions. Install will
+check if these are available.
+
+* These are usually part of the standard PHP package on most distributions:
+  * fileinfo
+  * filter
+  * hash
+  * openssl
+  * pcre
+  * session
+  * soap
+  * SPL
+  * standard
+  * xml
+  * zip
+  * zlib
+
+* These might have to be installed separately:
+  * gd
+  * json
+  * mysqli
+
+### Recommended setup
+
+There are plenty of possible setups for high performance TYPO3 installations
+(i.e. using Varnish Cache, Nginx, PHP-FPM, etc). Consider this resource for
+more ideas or suggestions:  http://wiki.typo3.org/Performance_tuning
+
+This is a basic recommended setup for best performance and increased
+functionality:
+
+* Apache with mod_expires and mod_rewrite enabled
+
+* MySQL 5.1 or newer
+
+* GraphicsMagick or ImageMagick v6 or newer installed on the server
+
+* PHP
+  * version 5.4 or later
+  * memory_limit set to at least 128M
+  * max_execution_time set to at least 240s
+
+* Additional PHP extensions:
+  * PHP opcode cache, i.e.: apc, xcache, eaccelerator, Zend Optimizer,
+    Zend OPcache, wincache (in case of an IIS installation)
+  * apc caching (with at least 100 MB of memory available)
+  * curl
+  * mbstring
+  * FreeType (usually included within the PHP distribution)
+
+* PHP access to /dev/urandom or /dev/random on Unix-like platforms for
+  increased security. Make sure to add "/dev/random:/dev/urandom" to
+  open_basedir settings if you use it. If these paths are unavailable, TYPO3
+  will attempt to simulate random number generation. This is less secure,
+  reduces performance and throws out warnings in the TYPO3 system log.
+
+* TYPO3 works with PHP's IPv6 support, which is enabled by default since
+  PHP 5.3. If you compile PHP 5.3 on your own, be aware not to use option
+  "--disable-ipv6", because this will break the IPv6 support and the according
+  unit tests.
+
+Installation
+------------
+
+### If SSH and symlinks are possible
+
+If you have SSH access to your webserver and are able to create symlinks,
+this is the recommended way of setting up TYPO3 so that it can easily
+be upgraded later through the Install Tool:
+
+* Uncompress the `typo3_src-6.2.x.tar.gz` file one level above the Document
+  Root of your Web server:
+```
+/var/www/site/htdocs/ $ cd ..
+/var/www/site/ $ tar xzf typo3_src-6.2.x.tar.gz
+```
+
+* Create the symlinks in your Document Root:
+```
+  cd htdocs
+  ln -s ../typo3_src-6.2.x typo3_src
+  ln -s typo3_src/index.php index.php
+  ln -s typo3_src/typo3 typo3
+```
+
+* In case you use Apache, copy the .htaccess to your Document Root:
+```
+  cp typo3_src/_.htaccess .htaccess
+```
+
+You end up with the follow structure of files:
+
+```
+  typo3_src-6.2.x/
+  htdocs/typo3_src -> ../typo3_src-6.2.x/
+  htdocs/typo3 -> typo3_src/typo3/
+  htdocs/index.php -> typo3_src/index.php
+  htdocs/.htaccess
+```
+
+This allows you to upgrade TYPO3 later by simply replacing the symlink
+with a newer version, or by using the integrated "Core Updater" which can
+be found in the Install Tool.
+
+### Windows specifics
+
+On Windows Vista and Windows 7, you can create symbolic links using
+the `mklink` tool:
+```
+  mklink /D C:\<dir>\example.com\typo3_src C:\<dir>\typo3_src-6.2.x
+```
+
+Users of Windows XP/2000 or newer can use the `junction` program by
+Marc Russinovich to create links. It can be downloaded at
+http://technet.microsoft.com/en-us/sysinternals/bb896768.aspx
+
+Windows users might need to copy `index.php` from the source directory to the
+web site root directory in case the Windows version does not support links
+for files.
+
+TYPO3 Core upgrades through the Install Tool is not supported under
+Windows.
+
+### No SSH and symlinks possible (not recommended)
+
+In case you only have FTP or SFTP access to your hosting environment, you
+can still install TYPO3, but you won't easily be able to upgrade your
+installation once a new patchlevel release is out.
+
+Please note that this is not a recommended setup!
+
+* Uncompress `typo3_src-6.2.x.tar.gz` locally
+* Upload all files and subdirectories directly in your Document Root
+  (where files that are served by your webserver are located).
+* In case your provider uses Apache:
+  * rename `_.htaccess` to `.htaccess`
+
+You end up with this files in your Document Root:
+
+```
+ .htaccess
+ ChangeLog
+ GPL.txt
+ index.php
+ INSTALL.md
+ LICENSE.txt
+ NEWS.txt
+ README.md
+ typo3/
+```
+
+Installation: further steps
+---------------------------
+
+Now access the web server using a web browser. You will be redirected to the
+Install Tool which will walk you through the steps for setting up TYPO3 for
+the first time.
+
+It will check if your environment conforms to the minimum system requirements
+and gives you some suggestions on what to change in case there are any
+discrepancies.
+
+The Install Tool will create the required directory structure for you
+(typo3conf, uploads, fileadmin, typo3temp).
+
+Former versions of TYPO3 required the download of a "Dummy Package"
+(or "Blank Package"). This is no longer required since version 6.2!
+
+TYPO3 Security
+--------------
+
+To ensure a secure installation, you have to make sure that you keep your
+TYPO3 core and the extensions up to date.
+
+* Subscribe to the announcement mailing list. This will inform you about new
+  releases of the TYPO3 core and security bulletins of core and community
+  extensions.
+  http://lists.typo3.org/cgi-bin/mailman/listinfo/typo3-announce
+
+* Use the scheduler task "Update Extension List (em)" to update the list of
+  available extensions regularly. You should check regularly, if new versions
+  of these extensions are available and apply these updates.
+
+* For further reading regarding securing TYPO3, please read the TYPO3 security
+  cookbook and other resources.
+  http://typo3.org/teams/security/resources/
+
+Installation FAQ
+----------------
+
+### 1
+Q:  Why do I get "500 Server error" when I navigate to my TYPO3 web site
+    immediately after installation?
+
+A:  If you are using Apache web server, check the Apache error log for specifics
+    on the error. The cause might be some missing module, or some syntax error
+    in your .htaccess file. The error log is usually located in /var/log/apache2
+    or /var/log/httpd. Check with your hosting provider if you are in doubt
+    where the logs are located.
+
+### 2
+Q:  I went through the setup process and created an admin user. Why can't I log
+    in now?
+
+A:  If you use MySQL 5.x or newer, try setting it to "compatible" mode. Open the
+    TYPO3 Install Tool under http://example.com/typo3/install/ (where
+    example.com is the web site domain), navigate to "All configuration".
+    Find "setDBinit", and add this line to the top of the input field:
+```
+       SET SESSION sql_mode='MYSQL40'
+```
+
+### 3
+Q:  Some modules or extensions make Apache crash on Windows. What is the cause?
+
+A:  Fluid uses complex regular expressions which require a lot of stack space
+    during the first processing. On Windows the default stack size for Apache
+    is a lot smaller than on unix. You can increase the size to 8MB (default on
+    unix) by adding to the httpd.conf:
+```
+       <IfModule mpm_winnt_module>
+               ThreadStackSize 8388608
+       </IfModule>
+```
+    Restart Apache after this change.
diff --git a/INSTALL.txt b/INSTALL.txt
deleted file mode 100644 (file)
index 437525f..0000000
+++ /dev/null
@@ -1,257 +0,0 @@
-*******************************************************************************
-INSTALLING TYPO3
-*******************************************************************************
-
-This document is a part of the TYPO3 project. TYPO3 is an open source web
-content management system released under the GNU GPL. TYPO3 is copyright
-(c) 1999-2013 by Kasper Skaarhoj.
-
-This document describes the system requirements for TYPO3 and the installation
-routine.
-
-
-===============================================================================
-System requirements
-===============================================================================
-
-TYPO3 requires a web server with a PHP installation and a database. While TYPO3
-can be configured to run on many web servers with different databases, this
-document assumes that Apache and MySQL will be used. This document does not
-cover using TYPO3 with other databases or web servers.
-
-The following configuration is the minimum required:
-
-- a web server capable of running PHP
-- PHP 5.3.7 or newer with the following extensions:
-       - fileinfo
-       - filter
-       - GD2
-       - JSON
-       - mysqli
-       - openssl
-       - pcre
-       - session
-       - SOAP
-       - SPL
-       - standard
-       - xml
-       - zlib
-- memory_limit set to at least 64M in php.ini
-- register_globals is disabled in php.ini
-- MySQL 5.0 or newer
-- 200 MB of disk space
-- AllowOverride in the Apache configuration includes "Indexes" and "FileInfo"
-  (see FAQ below)
-- Apache stack size 8MB (or more). (see FAQ below)
-
-The following configuration is recommended:
-
-- Apache 2.x
-- mod_expires and mod_rewrite enabled in the Apache configuration
-- PHP 5.3.7 or newer with the following extensions:
-       - cURL
-       - fileinfo
-       - filter
-       - GD2
-       - hash
-       - JSON
-       - mbstring
-       - mysqli
-       - openssl
-       - pcre
-       - session
-       - SOAP
-       - SPL
-       - standard
-       - xml
-       - zlib
-- Safe mode is not supported, thus it must not be activated
-- Magic Quotes is deprecated, thus it should be deactivated
-- memory_limit set to 128M or more in php.ini
-- MySQL 5.1 or newer
-- FreeType 2
-- GraphicsMagick or ImageMagick v6 or newer
-- 200 MB or more of disk space
-- AllowOverride in the Apache configuration includes "Indexes" and "FileInfo"
-  (see FAQ below)
-
-TYPO3 uses /dev/urandom or /dev/random on Unix-like platforms for security
-purposes. Access to these files is highly recommended and increases TYPO3
-security. Make sure to add "/dev/random:/dev/urandom" to open_basedir
-settings if you use it. If these paths are unavailable, TYPO3 will attempt to
-simulate random number generation. This is less secure, causes performance
-issues and warnings in the TYPO3 system log.
-
-TYPO3 relies on IPv6 support, which is by default enabled since PHP 5.3.
-Take care not to compile PHP 5.3 with the option "--disable-ipv6", because
-this will break the IPv6 support and the according unit tests.
-
-===============================================================================
-Obtaining TYPO3
-===============================================================================
-
-To get TYPO3, navigate to the following location:
-       http://typo3.org/download/
-
-TYPO3 consists of two packages: source and dummy. The source package contains
-files that are the same for every TYPO3 web site. The dummy package contains
-files unique to each TYPO3 installation.
-
-To install TYPO3, both packages must be downloaded.
-
-
-===============================================================================
-Installation: simple (not recommended!)
-===============================================================================
-
-This procedure is not recommended because it makes upgrades harder. However, it
-can be the only option if you hosting company does not provide SSH access to
-the web server.
-
-To install TYPO3, unpack the source package locally. Unpacking will produce a
-directory with a name like typo3_src-x.y.z, where x, y and z correspond to the
-TYPO3 version. For example, the TYPO3 x.y.z source package will create a
-directory named typo3_src-x.y.z.
-
-Next unpack the dummy package. This will create a directory with the name
-dummy-x.y.z. Now create a new directory and copy all files and folders from
-within typo3_src-x.y.z and dummy-x.y.z into this new directory.
-
-Use a FTP or SFTP program or any other available way to upload all files to
-the web server.
-
-Change permissions of the directories and files. The following directories and
-files should be read-only for the web server:
-       typo3/
-       index.php
-
-All other directories should be writable for the web server. If in doubt,
-contact your hosting company and ask them to assist in adjusting permissions.
-
-
-===============================================================================
-Installation: recommended
-===============================================================================
-
-To install TYPO3, unpack the source package outside of the web site root
-directory on your server. The location must be accessible to the web server.
-Unpacking will produce a directory with a name like typo3_src-x.y.z, where x,
-y and z correspond to the TYPO3 version. For example, the TYPO3 4.6.0 source
-package will create a directory named typo3_src-4.6.0.
-
-Unpack the dummy package in the temporary location on the server. This will
-create a dummy-x.y.z directory. Move all files and directories from the
-dummy-x.y.z directory to the web site root directory.
-
-Linux, Unix and Mac OS X users should use the tar.gz packages and unpack them
-using:
-       tar xzf source-x.y.z
-       tar xzf dummy-x.y.z
-
-Windows users can use Windows built-in unpacker on unpack ZIP versions of
-packages.
-
-On Linux, Unix or Mac OS X systems create a symbolic link named typo3_src
-pointing to the source package:
-       ln -s /var/www/typo3_src-4.6.0 /var/www/example.com/typo3_src
-
-On Windows Vista or Windows 7 create a symbolic link named typo3_src
-pointing to the source package:
-       mklink /D C:\<dir>\example.com\typo3_src C:\<dir>\typo3_src-4.6.0
-
-Users of Windows XP/2000 or newer can use the "junction" program by
-Marc Russinovich to create links. The program can be obtained at:
-       http://technet.microsoft.com/en-us/sysinternals/bb896768.aspx
-
-Next create link for the typo3/ directory:
-cd /var/www/example.com
-       ln -s typo3_src/typo3
-
-Linux, Unix and Mac OS X users also create a symbolic link to index.php
-       ln -s typo3_src/index.php
-
-Windows users must copy index.php from the source directory to the web site
-root directory because Windows does not support links for files.
-
-Change permissions and ownership of the directories. This usually requires the
-"sudo" command. Assuming that the web server user is in the group named
-"apache", execute the following commands in the web site root directory:
-       sudo chgrp -R apache fileadmin typo3temp typo3conf uploads
-       sudo chmod -R g+rwX,o-w fileadmin typo3temp typo3conf uploads
-
-If "sudo" is not available, ask your hosting company to change the permissions.
-
-
-===============================================================================
-Setting up TYPO3
-===============================================================================
-
-To set up TYPO3, navigate to your web site. The TYPO3 installer will run in the
-1-2-3 mode to easily guide you through the installation.
-
-
-===============================================================================
-Troubleshooting
-===============================================================================
-
-For troubleshooting read the FAQ below. If your problem is not listed, feel
-free to ask questions in the TYPO3 mailing lists:
-       http://typo3.org/support/mailing-lists/
-
-
-===============================================================================
-FAQ
-===============================================================================
-
-Q:     Why do I get "500 Server error" when I navigate to my TYPO3 web site
-       immediately after installation?
-A:     Make sure that AllowOverride allows "Indexes" and "FileInfo" in the Apache
-       configuration. If you cannot ensure this, rename .htaccess files to
-       _.htaccess. TYPO3 will run but considerably slower.
-       Here is the list of the files to rename:
-               typo3/contrib/.htaccess
-               typo3/gfx/.htaccess
-               typo3/mod/user/ws/.htaccess
-               typo3/sysext/.htaccess
-               typo3/sysext/t3skin/stylesheets/.htaccess
-       If the error does not disappear, web server error logs should help. For
-       Apache, the error log is usually located in /var/log/apache2 or
-       /var/log/httpd. Check with your hosting provider if you are in doubt where
-       the logs are located.
-
-Q:     Backend or Installer looks strange, no images just black and white?
-A:     Maybe you missed some configuration in your .htaccess file.
-       Have a look at typo3_src/misc/advanced.htaccess to find the options
-       you might need.
-
-Q:     I went through the setup process and created an admin user. Why can't I log
-       in now?
-A:     If you use MySQL 5.x or newer, try setting it to "compatible" mode. Open the
-       TYPO3 Install tool under http://example.com/typo3/install/ (where example.com
-       is the web site domain), navigate to "All configuration". find "setDBinit",
-       and add this line to the top of the input field:
-               SET SESSION sql_mode='MYSQL40'
-
-Q:     Some modules or extensions make Apache crash on Windows. What is the cause?
-A:     Fluid uses complex regular expressions which require a lot of stack space
-       during the first processing. On Windows the default stack size for Apache
-       is a lot smaller than on unix. You can increase the size to 8MB (default on
-       unix) by adding to the httpd.conf:
-               <IfModule mpm_winnt_module>
-                       ThreadStackSize 8388608
-               </IfModule>
-       Restart Apache after this change.
-
-Q:     What do I have to do regarding security?
-A:     You have to make sure that you keep your TYPO3-core and the extensions
-       up to date.
-       * Subscribe to the announcement mailing list. This will inform you about new
-         releases of the TYPO3 core and security bulletins of core and community
-         extensions.
-         http://lists.typo3.org/cgi-bin/mailman/listinfo/typo3-announce
-       * Use the scheduler task "Update Extension List (em)" to update the list of
-         available extensions regularly. You should check regularly, if new versions
-         of these extensions are available and install them respectively.
-       * For further reading regarding securing TYPO3, please read the TYPO3 security
-         cookbook and other resources. Please visit
-         http://typo3.org/teams/security/resources/
diff --git a/NEWS.md b/NEWS.md
new file mode 100644 (file)
index 0000000..0e2cf89
--- /dev/null
+++ b/NEWS.md
@@ -0,0 +1,106 @@
+TYPO3 CMS 6.2 - WHAT'S NEW
+==========================
+
+TYPO3 is an open source PHP based web content management system released
+under the GNU GPL. TYPO3 is copyright (c) 1999-2013 by Kasper Skaarhoj.
+
+This document provides information about what is new in the 6.2 release
+of TYPO3. An up-to-date version of this document also containing links to
+further in depth information can be found here:
+
+http://wiki.typo3.org/TYPO3_6.2
+
+System requirement changes
+--------------------------
+
+Minimum PHP version requirement raised to PHP 5.3.7. Please upgrade PHP first,
+if you plan to update from an older TYPO3 installation to 6.2!
+
+PHP 5.4 or later is recommended for improved performance.
+
+Consult INSTALL.md for complete system requirements.
+
+Changes and Improvements
+------------------------
+
+### Removed and moved components
+
+* Removed PHP constant PATH_t3lib
+* Moved ExtJS- & JavaScript files from t3lib to typo3
+
+### General
+
+* SpriteGenerator now supports high density sprites
+
+* New default value for cookieHttpOnly setting
+
+The session cookies "fe_typo_user" and "be_typo_user" now have set the
+HttpOnly attribute by default.  This will make it harder to steal the cookie
+by XSS attacks.
+
+### Logging
+
+* Logging API PSR-3 compliance
+
+The logger of the Logging API now complies with the PSR-3 standard of the
+PHP Framework Interop Group: http://www.php-fig.org/psr/3/
+
+### Backend
+
+* Categorization API improvements
+
+\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::makeCategorizable() can now
+be used multiple times on the same table to add more than one category field.
+The options array (the fourth parameter) now can contain a 'label' to set a
+custom label for each category field.
+
+### Frontend
+
+* Minor API change in \TYPO3\CMS\Frontend\ContentObjectRenderer->getTreeList()
+
+getTreeList() got some cleanup and slightly changed its return result. Former
+versions sometimes returned a trailing comma which is not the case anymore.
+
+Before:
+getTreeList(42, 4) // get pids for pageId 42, 4 levels deep
+result: '0, 22, 11, 4,'
+
+After:
+getTreeList(42, 4)
+result: '0, 22, 11, 4'
+
+### Administration / Customization
+
+* Content-length header (TypoScript setting config.enableContentLengthHeader)
+  is now enabled by default
+
+### Extbase
+
+* Recursive object validation
+
+Validation of object structures in extbase is now done recursively. If a tree
+of objects is created by the new property mapper, not only the top level object
+is validated, but all objects.
+
+* Allow empty validation
+
+In order to make a property required you now need to add the NotEmptyValidator
+to your property. The return value of validators is now optional.
+
+### Fluid
+
+* Image view helper does not render title tag by default
+
+In previous versions of fluid the image view helper always rendered the
+title attribute. If not set, the value of the required alt attribute was set as
+title.
+This fallback was removed with version 6.2. If not specifically set, title
+is not rendered anymore.
+
+Example:
+  Fluid Tag
+    <f:image src="{file}" alt="Alt-Attribute" />
+  will render
+    <img src="fileadmin/xxxx.jpg" alt="Alt-Attribute" />
+  and not
+    <img src="fileadmin/xxxx.jpg" alt="Alt-Attribute" title="Alt-Attribute" />
diff --git a/NEWS.txt b/NEWS.txt
deleted file mode 100644 (file)
index 40cd6c2..0000000
--- a/NEWS.txt
+++ /dev/null
@@ -1,128 +0,0 @@
-This document is a part of the TYPO3 project. TYPO3 is an open source web
-content management system released under the GNU GPL. TYPO3 is copyright
-(c) 1999-2012 by Kasper Skaarhoj.
-
-This document contains information about TYPO3 version 6.2 has been released
-on MONTH-NAME XXth 2013.
-
-An up-to-date version of this document also containing links to further in
-depth information can be found here:
-
-http://wiki.typo3.org/TYPO3_6.2
-
-===============================================================================
-Compatibility
-===============================================================================
-
--------------------------------------------------------------------------------
-System environment
--------------------------------------------------------------------------------
-
-* Raised minimum PHP version requirement to 5.3.7
-
--------------------------------------------------------------------------------
-Deprecated and removed components
--------------------------------------------------------------------------------
-
-* Removed PHP constant PATH_t3lib
-
-===============================================================================
-Changes and Improvements
-===============================================================================
-
-* Moved ExtJS- & JavaScript files from t3lib to typo3
-
--------------------------------------------------------------------------------
-General
--------------------------------------------------------------------------------
-
-* SpriteGenerator now supports high density sprites
-
-It is now possible to create high density sprites.
-
-* New default value for cookieHttpOnly setting
-
-The session cookies "fe_typo_user" and "be_typo_user" now have set the
-HttpOnly attribute by default. This will make it harder to steal the cookie by
-XSS attacks.
-
--------------------------------------------------------------------------------
-Logging
--------------------------------------------------------------------------------
-
-* Logging API PSR-3 compliance
-
-The logger of the Logging API now complies with the PSR-3 standard of the
-PHP Framework Interop Group: http://www.php-fig.org/psr/3/
-
--------------------------------------------------------------------------------
-Backend
--------------------------------------------------------------------------------
-
-* Categorization API improvements
-
-\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::makeCategorizable() can now
-be used multiple times on the same table to add more than one category field.
-The options array (the fourth parameter) now can contain a 'label' to set a
-custom label for each category field.
-
--------------------------------------------------------------------------------
-Frontend
--------------------------------------------------------------------------------
-
-* Minor API change in \TYPO3\CMS\Frontend\ContentObjectRenderer->getTreeList()
-
-getTreeList() got some cleanup and slightly changed its return result. Former
-versions sometimes returned a trailing comma which is not the case anymore.
-
-Before:
-getTreeList(42, 4) // get pids for pageId 42, 4 levels deep
-result: '0, 22, 11, 4,'
-
-After:
-getTreeList(42, 4)
-result: '0, 22, 11, 4'
-
--------------------------------------------------------------------------------
-Administration / Customization
--------------------------------------------------------------------------------
-
-* Content-length Header is now enabled by default
-
-The TypoScript setting config.enableContentLengthHeader has a new default
-value and is now enabled by default.
-
--------------------------------------------------------------------------------
-Extbase
--------------------------------------------------------------------------------
-
-* Recursive object validation
-
-Validation of object structures in extbase is now done recursively. If a tree
-of objects is created by the new property mapper, not only the top level object
-is validated, but all objects.
-
-* Allow empty validation
-
-In order to make a property required you now need to add the NotEmptyValidator
-to your property. The return value of validators is now optional.
-
--------------------------------------------------------------------------------
-Fluid
--------------------------------------------------------------------------------
-
-* Image view helper does not render title tag by default
-
-In previous versions of fluid the image view helper always rendered the
-title attribute. If not set, the value of the required alt attribute was set as
-title.
-This fallback was removed with version 6.2. If not specifically set, title
-is not rendered anymore.
-
-Example:
-  Fluid Tag
-    <f:image src="{file}" alt="Alt-Attribute" />
-  will render
-    <img src="fileadmin/xxxx.jpg" alt="Alt-Attribute" />
-  and not
-    <img src="fileadmin/xxxx.jpg" alt="Alt-Attribute" title="Alt-Attribute" />
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..d18a743
--- /dev/null
+++ b/README.md
@@ -0,0 +1,149 @@
+TYPO3 CMS
+=========
+
+TYPO3 is an open source PHP based web content management system released
+under the GNU GPL. TYPO3 is copyright (c) 1999-2013 by Kasper Skaarhoj.
+
+This document provides a basic introduction to TYPO3.
+
+Getting Started
+---------------
+
+TYPO3 requires a webserver with PHP and a database (MySQL recommended).
+Accessing the backend through a supported browser.
+
+Please see the INSTALL.md in this folder in order to set up a basic TYPO3
+installation on your webserver.
+
+What is TYPO3?
+--------------
+
+TYPO3 is a free and open source Content Management Framework. It is released
+under the GNU General Public License. It can run on several web servers, such
+as Apache or IIS, on top of many operating systems, among them Linux, Microsoft
+Windows, FreeBSD or MacOS X.
+
+TYPO3 was initially authored by Kasper Skårhøj and is now further developed
+by a community of Active Contributors around a small TYPO3 CMS Team.
+
+To get more info about the GPL license, visit
+http://www.opensource.org/licenses/gpl-license.php
+
+What is a Content Management Framework?
+---------------------------------------
+
+A Content Management Framework is more than just a content management system,
+due to the separation of the streamlined core and optional plugins
+(extensions). TYPO3 has an open API that allows you to extend the frontend (web
+site) and/or backend (administration) functionalities.
+
+The concept of extensions makes TYPO3 capable of being developed and used
+in almost any way you can imagine, either by using any of the many extensions
+which are available for download, or by writing your own.
+
+TYPO3 System requirements
+-----------------------------
+
+TYPO3 is based upon PHP and uses a MySQL database. For more information
+regarding these requirements see the INSTALL.md file in this folder.
+
+Using the Database Abstraction Layer (DBAL) allows one to use TYPO3 with other
+Database Management Systems, like PostgreSQL, Oracle and MSSQL.
+
+TYPO3 resources
+---------------
+
+Here is an overview of the most important TYPO3 resources to help you get
+started:
+
+### Text files bundled in this package
+
+* README.md: This file, provides a basic overview on the product and
+  points to important resources.
+
+* INSTALL.md: System requirements to install and use TYPO3, the basic
+  installation instructions and information about upgrading an existing
+  installation to the new version.
+
+* NEWS.md: An overview of changes that were made in this particular TYPO3
+  release. More in-depth information can be found in the corresponding
+  release announcements.
+
+### Get more information
+
+* http://typo3.org is the main project website. It provides up to
+  date official news, information about events, access to downloading the
+  products and extensions.
+
+* http://wiki.typo3.org is a collaborative wiki, providing access to
+  all kind of information around the TYPO3 ecosphere.
+
+* http://www.typo3.org/documentation: TYPO3 is one of the most thoroughly
+  documented OpenSource products around, with manuals covering basic
+  tutorials, TypoScript, administration, development, core structure, etc.
+  You should make the time to locate the various documents, and read those
+  that apply to the work you want to do.
+
+### Exchange information, get help
+
+The community and all TYPO3 teams communicate through newsgroups, which can
+also be accessed through mailing lists and forums. Any of these three ways
+provide access to the same communication channels:
+
+* Forum (Web): http://forum.typo3.org/
+* Mailing Lists (Mail): http://typo3.org/support/mailing-lists/
+* Newsgroups (NNTP): news://lists.typo3.org/
+
+### Participate in the development
+
+If you want to file a bug report, maintain your own extension using our
+infrastructure (Git, Issue Tracker, Wiki, etc), take a look at:
+
+* http://forge.typo3.org
+
+If you want to contribute to the TYPO3 CMS source code, take a look at our
+Contributors Walkthrough:
+
+* http://wiki.typo3.org/CWT
+
+### Chat with us
+
+Several teams use IRC as a way to communicate internally and most channels
+are a welcome place for you to join and get yourself involved.
+
+* IRC: http://typo3.org/support/irc-chat/
+
+Final notes
+-----------
+
+TYPO3 is said to be one of the most sophisticated PHP / Internet related
+applications available, and the more you play with it, the more you will agree.
+
+Due to the advanced level of the code and functionality, a degree of study,
+time and perseverance is required to fully understand it, and get the best from
+it. You should keep trying, as we say it's definitely worth it. TYPO3 is the
+Enterprise Content Management System "for all".
+
+The GPL license allows for developments that are based upon TYPO3 to also be
+freely available under the GPL. Please remember this, because TYPO3 is about
+"Inspiring People To Share". If you are making money with TYPO3 you can donate
+or become a member of the TYPO3 Association.
+
+By becoming a supporting member, individuals and organisations mainly fund
+core development of TYPO3. The decision about what the funds are used for, is
+made by all members of the Association and the Expert Advisory Board (EAB).
+The decisions will be made transparent to the community and especially the
+supporting members. Your funds will also serve for other purposes as laid
+out in the bylaws.
+
+* Donate: http://typo3.org/donate
+* Become a member of the TYPO3 Association:
+  http://association.typo3.org/association/join-now/
+
+Copyleft
+--------
+
+This document is a part of the TYPO3 project.
+
+Written by Nigel Jackson, Ingmar Schlecht, Ernesto Baschny, Michael Stucki,
+Oliver Hader, Ben van 't Ende and others.