public/assets/plugins/ckeditor/README.md

   1 CKEditor 4 - Releases
   2 =====================
   3
   4 ## Releases Code
   5
   6 This repository contains the official release versions of [CKEditor](http://ckeditor.com).
   7
   8 There are four versions for each release &mdash; `standard-all`, `basic`, `standard`, and `full`.
   9 They differ in the number of plugins that are compiled into the main `ckeditor.js` file as well as the toolbar configuration.
  10
  11 See the [comparison](http://ckeditor.com/presets) of the `basic`, `standard`, and `full` installation presets for more details.
  12
  13 The `standard-all` build includes all official CKSource plugins with only those from the `standard` installation preset compiled into the `ckeditor.js` file and enabled in the configuration.
  14
  15 All versions available in this repository were built using [CKBuilder](http://ckeditor.com/builder), so they are optimized and ready to be used in a production environment.
  16
  17 ## Documentation
  18
  19 Developer documentation for CKEditor is available online at: <http://docs.ckeditor.com>.
  20
  21 ## Installation
  22
  23 ### Git clone
  24
  25 To install one of the available releases, just clone this repository and switch to the respective branch (see next section):
  26
  27         git clone -b <release branch> git://github.com/ckeditor/ckeditor-releases.git
  28
  29 ### Git submodule
  30
  31 If you are using git for your project and you want to integrate CKEditor, we recommend to add this repository as a
  32 [submodule](http://git-scm.com/book/en/Git-Tools-Submodules).
  33
  34         git submodule add -b <release branch> git://github.com/ckeditor/ckeditor-releases.git <clone dir>
  35         git commit -m "Added CKEditor submodule in <clone dir> directory."
  36
  37 ### Using Package Managers
  38
  39 See the [Installing CKEditor with Package Managers](http://docs.ckeditor.com/#!/guide/dev_package_managers) article for more details about installing CKEditor with [Bower](http://bower.io/), [Composer](https://getcomposer.org/) and [npm](https://www.npmjs.com/).
  40
  41 ## Repository Structure
  42
  43 ### Branches
  44
  45 This repository contains the following branches:
  46
  47   - `master` and `latest` &ndash; the latest release of the `standard-all` preset (including betas).
  48   - `stable` &ndash; the latest stable release of the `standard-all` preset (non-beta).
  49   - `A.B.x` (e.g. `4.3.x`) &ndash; the latest release of the `standard-all` preset in the `A.B` branch.
  50   - `(basic|standard|full)/stable` &ndash; the latest stable release tag point (non-beta).
  51   - `(basic|standard|full)/latest` &ndash; the latest release tag point (including betas).
  52   - `(basic|standard|full)/A.B.x` (e.g. `basic/4.0.x`) &ndash; the latest releases in the `A.B` branch.
  53
  54 ### Tags
  55
  56 **Since version 4.3.3** this repository uses the following tag naming rules:
  57
  58   - `x.y.z` &ndash; contains the `standard-all` editor build, e.g. `4.3.3`, `4.4.0` etc.
  59   - `(basic|standard|full)/x.y.z` &ndash; contains the editor build with a given preset, e.g. `basic/4.3.3`.
  60
  61 The version numbers follow the [Semantic Versioning 2.0.0](http://semver.org/) scheme.
  62
  63 Up to version **4.3.2** the tags were released in the following form `x.y[.z]/(basic|standard|full)`.
  64 For example: `4.0/basic`, `4.0.1/standard`. This convention was changed in CKEditor 4.3.3 to conform to the Semantic Versioning scheme.
  65
  66 ## Checking Your Installation
  67
  68 The editor comes with a sample page that can be used to verify if the installation succeeded. Take a look at the `samples` directory.
  69
  70 To test your installation, just call the following page for your website:
  71
  72         http://<your site>/<CKEditor installation path>/samples/index.html
  73
  74 For example:
  75
  76         http://www.example.com/ckeditor/samples/index.html
  77
  78 ### License
  79
  80 Licensed under the GPL, LGPL, and MPL licenses, at your choice.
  81
  82 Please check the `LICENSE.md` file for more information about the license.