README.md

   1 # Kohana PHP Framework - core
   2
   3 | ver   | Stable                                                                                                                       | Develop                                                                                                                        |
   4 |-------|------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------|
   5 | 3.3.x | [![Build Status - 3.3/master](https://travis-ci.org/kohana/core.svg?branch=3.3%2Fmaster)](https://travis-ci.org/kohana/core) | [![Build Status - 3.3/develop](https://travis-ci.org/kohana/core.svg?branch=3.3%2Fdevelop)](https://travis-ci.org/kohana/core) |
   6 | 3.4.x | [![Build Status - 3.4/master](https://travis-ci.org/kohana/core.svg?branch=3.4%2Fmaster)](https://travis-ci.org/kohana/core) | [![Build Status - 3.4/develop](https://travis-ci.org/kohana/core.svg?branch=3.4%2Fdevelop)](https://travis-ci.org/kohana/core) |
   7
   8 This is the core package for the [Kohana](http://kohanaframework.org/) object oriented HMVC framework built using PHP5.
   9 It aims to be swift, secure, and small.
  10
  11 Released under a [BSD license](http://kohanaframework.org/license), Kohana can be used legally for any open source,
  12 commercial, or personal project.
  13
  14 ## Documentation and installation
  15
  16 See the [sample application repository](https://github.com/kohana/kohana) for full readme and contributing information.
  17 You will usually add `kohana/core` as a dependency in your own project's composer.json to install and work with this
  18 package.
  19
  20 ## Installation for development
  21
  22 To work on this package, you'll want to install it with composer to get the required dependencies. Note that there are
  23 currently circular dependencies between this module and kohana/unittest. These may cause you problems if you are working
  24 on a feature branch, because composer may not be able to figure out which version of kohana core you have.
  25
  26 To work around this, run composer like: `COMPOSER_ROOT_VERSION=3.3.x-dev composer install`. This tells composer that the
  27 current checkout is a 3.3.* development version. Obviously change the argument if your branch is based on a different
  28 version.
  29
  30 After installing the dependencies, you'll need a skeleton Kohana application before you can run the unit tests etc. The
  31 simplest way to do this is to use kohana/koharness to build a bare project in `/tmp/koharness`.
  32
  33 If in doubt, check the install and test steps in the [.travis.yml](.travis.yml) file.