Skip to content

Commit

Permalink
Added branches description into readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
fredck committed Nov 23, 2012
1 parent 17bae42 commit 769d961
Showing 1 changed file with 27 additions and 8 deletions.
35 changes: 27 additions & 8 deletions README.md
Expand Up @@ -5,16 +5,34 @@ CKEditor 4 - The best browser-based WYSIWYG editor

This repository contains the development version of CKEditor.

**Attention:** The code in this repository should be used locally and for development purposes only.
We don't recommend distributing it on remote websites because the user experience will be very limited.
For that purpose, you should build it (see below) or use an official release instead,
available on the [CKEditor website](http://ckeditor.com).
**Attention:** The code in this repository should be used locally and for
development purposes only. We don't recommend distributing it on remote websites
because the user experience will be very limited. For that purpose, you should
build it (see below) or use an official release instead, available on the
[CKEditor website](http://ckeditor.com).

### Code Installation

There is no special installation procedure to install the development code.
Simply clone it on any local directory and you're set.

### Available Branches

This repository contains the following branches:

- **master***: development of the upcoming minor release.
- **major***: development of the upcoming major release.
- **stable**: latest stable release tag point (non-beta).
- **latest**: latest release tag point (including betas).
- **release/A.B.x** (e.g. 4.0.x, 4.1.x): release freeze, tests and tagging.
Hotfixing.

(*) Note that both **master** and **major** are under heavy development. Their
code didn't pass the release testing phase so it may be unstable.

Additionally, all releases will have their relative tags in this form: 4.0,
4.0.1, etc.

### Samples

The `samples/` folder contains a good set of examples that can be used
Expand All @@ -34,13 +52,14 @@ The development code contains the following main elements:

### Building a Release

A release optimized version of the development code can be easily created locally.
The `dev/builder/build.sh` script can be used for that purpose:
A release optimized version of the development code can be easily created
locally. The `dev/builder/build.sh` script can be used for that purpose:

> ./dev/builder/build.sh

A "release ready" working copy of your development code will be built in the new `dev/builder/release/` folder.
An internet connection is necessary to run the builder, for its first time at least.
A "release ready" working copy of your development code will be built in the new
`dev/builder/release/` folder. An internet connection is necessary to run the
builder, for its first time at least.

### License

Expand Down

0 comments on commit 769d961

Please sign in to comment.