Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 56 lines (34 sloc) 2.088 kb
0615a2f @dg updated composer.json, license.md, readme.md
dg authored
1 [Nette Framework](http://nette.org)
2 ===================================
3
4 Nette Framework is a popular tool for PHP web development. It is designed to be
5 the most usable and friendliest as possible. It focuses on security and
6 performance and is definitely one of the safest PHP frameworks.
7
8 Nette Framework speaks your language and helps you to easily build better websites.
9
10
11 Requirements
12 ------------
13
14 Nette Framework package for PHP 5.3 requires PHP 5.3.0 or later. The package
15 for PHP 5.2 works with PHP 5.2.0 or later. Please run [Requirements
16 Checker](http://doc.nette.org/requirements) to obtain more detailed information.
17
18
19 Installation
20 ------------
21
41282c2 @dg typos
dg authored
22 The best way to install Nette Framework is to download the latest package
23 from http://nette.org/download or use [Composer](http://doc.nette.org/composer).
0615a2f @dg updated composer.json, license.md, readme.md
dg authored
24 The downloaded package includes the following directories:
25
26 - `Nette`: this directory contains the source code of Nette Framework. This is
27 the only directory that you will need in order to deploy your application.
28
41282c2 @dg typos
dg authored
29 - `Nette-minified`: contains Nette Framework source code compressed into a single file.
0615a2f @dg updated composer.json, license.md, readme.md
dg authored
30
31 - `client-side`: this directory contains the JavaScript source codes.
32
41282c2 @dg typos
dg authored
33 - `API-reference`: generated API documentation of the framework in HTML format. This is
34 generated using [ApiGen](http://apigen.org) from the contents of the Nette directory.
0615a2f @dg updated composer.json, license.md, readme.md
dg authored
35
36 - `examples`: contains some Nette Framework demo applications.
37
38 - `sandbox`: contains a pre-packaged Nette Framework project, basic configured
39 structure for your application.
40
41 - `tests`: contains Nette Framework unit tests and testing tool.
42
41282c2 @dg typos
dg authored
43 - `tools`: contains supporting tools such as the Requirements Checker, script that
44 can check if your system meets the requirements for running Nette Framework.
0615a2f @dg updated composer.json, license.md, readme.md
dg authored
45
46
47 Getting started
48 ---------------
49
50 The [Quick Start tutorial](http://doc.nette.org/quickstart) gives you a first
51 introduction to the framework by creating a simple database driven application.
52
53 -----
54
55 [![Build Status](https://secure.travis-ci.org/nette/nette.png?branch=master)](http://travis-ci.org/nette/nette)
Something went wrong with that request. Please try again.