xref: /webtrees/public/ckeditor-4.15.1-custom/README.md (revision 2ebcf907ed34213f816592af04e6c160335d6311)
1CKEditor 4
2==========
3
4Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
5https://ckeditor.com - See LICENSE.md for license information.
6
7CKEditor 4 is a text editor to be used inside web pages. It's not a replacement
8for desktop text editors like Word or OpenOffice, but a component to be used as
9part of web applications and websites.
10
11## Documentation
12
13The full editor documentation is available online at the following address:
14https://ckeditor.com/docs/
15
16## Installation
17
18Installing CKEditor is an easy task. Just follow these simple steps:
19
20 1. **Download** the latest version from the CKEditor website:
21    https://ckeditor.com. You should have already completed this step, but be
22    sure you have the very latest version.
23 2. **Extract** (decompress) the downloaded file into the root of your website.
24
25**Note:** CKEditor is by default installed in the `ckeditor` folder. You can
26place the files in whichever you want though.
27
28## Checking Your Installation
29
30The editor comes with a few sample pages that can be used to verify that
31installation proceeded properly. Take a look at the `samples` directory.
32
33To test your installation, just call the following page at your website:
34
35	http://<your site>/<CKEditor installation path>/samples/index.html
36
37For example:
38
39	http://www.example.com/ckeditor/samples/index.html
40