Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
14 changed files
with
762 additions
and
138 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,73 +1,75 @@ | ||
CKEditor 4 - The best browser-based WYSIWYG editor | ||
================================================== | ||
|
||
## Development Code | ||
# 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 | ||
development purposes only. We do not recommend using it in production environment | ||
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 | ||
either build the editor (see below) or use an official release available on the | ||
[CKEditor website](http://ckeditor.com). | ||
|
||
### Code Installation | ||
## Code Installation | ||
|
||
There is no special installation procedure to install the development code. | ||
Simply clone it on any local directory and you're set. | ||
Simply clone it to any local directory and you are set. | ||
|
||
### Available Branches | ||
## 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. | ||
- **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. | ||
code did not pass the release testing phase, though, so it may be unstable. | ||
|
||
Additionally, all releases will have their relative tags in this form: 4.0, | ||
4.0.1, etc. | ||
Additionally, all releases have their respective tags in the following form: 4.4.0, | ||
4.4.1, etc. | ||
|
||
### Samples | ||
## Samples | ||
|
||
The `samples/` folder contains a good set of examples that can be used | ||
to test your installation. It can also be a precious resource for learning | ||
some aspects of the CKEditor JavaScript API and its integration on web pages. | ||
The `samples/` folder contains some examples that can be used to test your | ||
installation. Visit [CKEditor SDK](http://sdk.ckeditor.com/) for plenty of samples | ||
showcasing numerous editor featurs, with source code readily available to view, copy | ||
and use in your own solution. | ||
|
||
### Code Structure | ||
## Code Structure | ||
|
||
The development code contains the following main elements: | ||
|
||
- Main coding folders: | ||
- `core/`: the core API of CKEditor. Alone, it does nothing, but | ||
- `core/` – The core API of CKEditor. Alone, it does nothing, but | ||
it provides the entire JavaScript API that makes the magic happen. | ||
- `plugins/`: contains most of the plugins maintained by the CKEditor core team. | ||
- `skin/`: contains the official default skin of CKEditor. | ||
- `dev/`: contains "developer tools". | ||
- `tests/`: contains CKEditor tests suite. | ||
- `plugins/` – Contains most of the plugins maintained by the CKEditor core team. | ||
- `skin/` – Contains the official default skin of CKEditor. | ||
- `dev/` – Contains some developer tools. | ||
- `tests/` – Contains the CKEditor tests suite. | ||
|
||
### Building a Release | ||
## Building a Release | ||
|
||
A release optimized version of the development code can be easily created | ||
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 | ||
`dev/builder/release/` folder. An Internet connection is necessary to run the | ||
builder, for its first time at least. | ||
|
||
### Testing Environment | ||
## Testing Environment | ||
|
||
Read more on how to set up the environment and execute tests in the [CKEditor Testing Environment](http://docs.ckeditor.com/#!/guide/dev_tests) guide. | ||
|
||
### License | ||
## Reporting Issues | ||
|
||
Please use the [CKEditor Developer Center](https://dev.ckeditor.com/) to report bugs and feature requests. | ||
|
||
## License | ||
|
||
Licensed under the GPL, LGPL and MPL licenses, at your choice. | ||
|
||
For full details about the license, please check the LICENSE.md file. | ||
For full details about the license please check the LICENSE.md file. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.