blob: b6520080e9129a539e2c820c09060b1e38db1db7 [file] [log] [blame]
Derek Jonesf4a4bd82011-10-20 12:18:42 -05001###################
2What is CodeIgniter
3###################
4
5CodeIgniter is an Application Development Framework - a toolkit - for people
6who build web sites using PHP. Its goal is to enable you to develop projects
7much faster than you could if you were writing code from scratch, by providing
8a rich set of libraries for commonly needed tasks, as well as a simple
9interface and logical structure to access these libraries. CodeIgniter lets
10you creatively focus on your project by minimizing the amount of code needed
11for a given task.
12
13*******************
14Release Information
15*******************
16
James Swift3b96a172013-08-23 23:13:07 +010017This repo contains in-development code for future releases. To download the
Derek Jonesf4a4bd82011-10-20 12:18:42 -050018latest stable release please visit the `CodeIgniter Downloads
Andrey Andreevbd202c92016-01-11 12:50:18 +020019<https://codeigniter.com/download>`_ page.
Derek Jonesf4a4bd82011-10-20 12:18:42 -050020
21**************************
22Changelog and New Features
23**************************
24
25You can find a list of all changes for each release in the `user
Bo-Yi Wu9f8a5f02014-10-25 13:34:10 +080026guide change log <https://github.com/bcit-ci/CodeIgniter/blob/develop/user_guide_src/source/changelog.rst>`_.
Derek Jonesf4a4bd82011-10-20 12:18:42 -050027
28*******************
29Server Requirements
30*******************
31
Claudio Galdiolo606ad652016-07-07 15:32:12 -040032PHP version 5.6 or newer is recommended.
Andrey Andreev934d6d92015-01-12 15:03:10 +020033
Andrey Andreev54f6a092016-07-26 20:21:39 +030034It should work on 5.3.7 as well, but we strongly advise you NOT to run
Andrey Andreev934d6d92015-01-12 15:03:10 +020035such old versions of PHP, because of potential security and performance
36issues, as well as missing features.
Derek Jonesf4a4bd82011-10-20 12:18:42 -050037
38************
39Installation
40************
41
Andrey Andreevbd202c92016-01-11 12:50:18 +020042Please see the `installation section <https://codeigniter.com/user_guide/installation/index.html>`_
Derek Jonesf4a4bd82011-10-20 12:18:42 -050043of the CodeIgniter User Guide.
44
Derek Jonesf4a4bd82011-10-20 12:18:42 -050045*******
46License
47*******
48
49Please see the `license
Andrey Andreevdc63a022014-10-28 00:27:40 +020050agreement <https://github.com/bcit-ci/CodeIgniter/blob/develop/user_guide_src/source/license.rst>`_.
Derek Jonesf4a4bd82011-10-20 12:18:42 -050051
52*********
53Resources
54*********
55
Andrey Andreevbd202c92016-01-11 12:50:18 +020056- `User Guide <https://codeigniter.com/docs>`_
Master Yoda7762c592015-03-06 16:08:59 -080057- `Language File Translations <https://github.com/bcit-ci/codeigniter3-translations>`_
Bo-Yi Wu9f8a5f02014-10-25 13:34:10 +080058- `Community Forums <http://forum.codeigniter.com/>`_
59- `Community Wiki <https://github.com/bcit-ci/CodeIgniter/wiki>`_
Instructor, Computer Systems Technology1d9e2962017-07-26 21:42:14 -070060- `Community Slack Channel <https://codeigniterchat.slack.com>`_
Derek Jonesf4a4bd82011-10-20 12:18:42 -050061
Andrey Andreevb2d25352015-10-23 14:11:47 +030062Report security issues to our `Security Panel <mailto:security@codeigniter.com>`_
63or via our `page on HackerOne <https://hackerone.com/codeigniter>`_, thank you.
Master Yoda7762c592015-03-06 16:08:59 -080064
Derek Jonesf4a4bd82011-10-20 12:18:42 -050065***************
66Acknowledgement
67***************
68
Master Yoda7762c592015-03-06 16:08:59 -080069The CodeIgniter team would like to thank EllisLab, all the
Claudio Galdiolo606ad652016-07-07 15:32:12 -040070contributors to the CodeIgniter project and you, the CodeIgniter user.