[TASK] Use font-awesome icons in ext:version
[Packages/TYPO3.CMS.git] / README.md
1 TYPO3 CMS
2 =========
3
4 [![Build Status](https://travis-ci.org/TYPO3/TYPO3.CMS.svg?branch=master)](https://travis-ci.org/TYPO3/TYPO3.CMS)
5
6 TYPO3 is an open source PHP based web content management system released
7 under the GNU GPL. TYPO3 is copyright (c) 1999-2015 by Kasper Skaarhoj.
8
9 This document provides a basic introduction to TYPO3.
10
11 Getting Started
12 ---------------
13
14 TYPO3 requires a webserver with PHP and a database (MySQL recommended).
15 Accessing the backend through a supported browser.
16
17 Please see the INSTALL.md in this folder in order to set up a basic TYPO3
18 installation on your webserver.
19
20 What is TYPO3?
21 --------------
22
23 TYPO3 is a free and open source Content Management Framework. It is released
24 under the GNU General Public License. It can run on several web servers, such
25 as Apache or IIS, on top of many operating systems, among them Linux, Microsoft
26 Windows, FreeBSD or MacOS X.
27
28 TYPO3 was initially authored by Kasper Skårhøj and is now further developed
29 by a community of Active Contributors around a small TYPO3 CMS Team.
30
31 To get more info about the GPL license, visit
32 http://www.opensource.org/licenses/gpl-license.php
33
34 What is a Content Management Framework?
35 ---------------------------------------
36
37 A Content Management Framework is more than just a content management system,
38 due to the separation of the streamlined core and optional plugins
39 (extensions). TYPO3 has an open API that allows you to extend the frontend (web
40 site) and/or backend (administration) functionalities.
41
42 The concept of extensions makes TYPO3 capable of being developed and used
43 in almost any way you can imagine, either by using any of the many extensions
44 which are available for download, or by writing your own.
45
46 TYPO3 System requirements
47 -----------------------------
48
49 TYPO3 is based upon PHP and uses a MySQL database. For more information
50 regarding these requirements see the INSTALL.md file in this folder.
51
52 Using the Database Abstraction Layer (DBAL) allows one to use TYPO3 with other
53 Database Management Systems, like PostgreSQL, Oracle and MSSQL.
54
55 TYPO3 resources
56 ---------------
57
58 Here is an overview of the most important TYPO3 resources to help you get
59 started:
60
61 ### Text files bundled in this package
62
63 * README.md: This file, provides a basic overview on the product and
64   points to important resources.
65
66 * INSTALL.md: System requirements to install and use TYPO3, the basic
67   installation instructions and information about upgrading an existing
68   installation to the new version.
69
70 ### Get more information
71
72 * http://typo3.org is the main project website. It provides up to
73   date official news, information about events, access to downloading the
74   products and extensions.
75
76 * http://wiki.typo3.org is a collaborative wiki, providing access to
77   all kind of information around the TYPO3 ecosphere.
78
79 * http://www.typo3.org/documentation: TYPO3 is one of the most thoroughly
80   documented OpenSource products around, with manuals covering basic
81   tutorials, TypoScript, administration, development, core structure, etc.
82   You should make the time to locate the various documents, and read those
83   that apply to the work you want to do.
84
85 ### Chat with us
86
87 The TYPO3 team is using a tool called Slack to openly communicate with each
88 other and with the public. Several teams use Slack as a way to communicate
89 internally and most channels are a welcome place for you to join and get
90 yourself involved.
91
92 * Register: https://forger.typo3.org/slack/
93 * Slack: https://typo3.slack.com/
94
95 ### Exchange information, get help
96
97 The community and all TYPO3 teams communicate through newsgroups, which can
98 also be accessed through mailing lists and forums. Any of these three ways
99 provide access to the same communication channels:
100
101 * Forum (Web): http://forum.typo3.org/
102 * Mailing Lists (Mail): http://typo3.org/support/mailing-lists/
103 * Newsgroups (NNTP): news://lists.typo3.org/
104
105 ### Participate in the development
106
107 If you want to file a bug report, maintain your own extension using our
108 infrastructure (Git, Issue Tracker, Wiki, etc), take a look at:
109
110 * http://forge.typo3.org
111
112 If you want to contribute to the TYPO3 CMS source code, take a look at our
113 Contributors Walkthrough:
114
115 * http://wiki.typo3.org/CWT
116
117 Final notes
118 -----------
119
120 TYPO3 is said to be one of the most sophisticated PHP / Internet related
121 applications available, and the more you play with it, the more you will agree.
122
123 Due to the advanced level of the code and functionality, a degree of study,
124 time and perseverance is required to fully understand it, and get the best from
125 it. You should keep trying, as we say it's definitely worth it. TYPO3 is the
126 Enterprise Content Management System "for all".
127
128 The GPL license allows for developments that are based upon TYPO3 to also be
129 freely available under the GPL. Please remember this, because TYPO3 is about
130 "Inspiring People To Share". If you are making money with TYPO3 you can donate
131 or become a member of the TYPO3 Association.
132
133 By becoming a supporting member, individuals and organisations mainly fund
134 core development of TYPO3. The decision about what the funds are used for, is
135 made by all members of the Association and the Expert Advisory Board (EAB).
136 The decisions will be made transparent to the community and especially the
137 supporting members. Your funds will also serve for other purposes as laid
138 out in the bylaws.
139
140 * Donate: http://typo3.org/donate
141 * Become a member of the TYPO3 Association:
142   http://association.typo3.org/association/join-now/
143
144 Copyleft
145 --------
146
147 This document is a part of the TYPO3 project.
148
149 Written by Nigel Jackson, Ingmar Schlecht, Ernesto Baschny, Michael Stucki,
150 Oliver Hader, Ben van 't Ende and others.