1TinyMCE - JavaScript Library for Rich Text Editing
  2===================================================
  3
  4Building TinyMCE
  5-----------------
  6Install [Node.js](https://nodejs.org/en/) on your system.
  7Clone this repository on your system
  8```
  9$ git clone https://github.com/tinymce/tinymce.git
 10```
 11Open a console and go to the project directory.
 12```
 13$ cd tinymce/
 14```
 15Install `grunt` command line tool globally.
 16```
 17$ npm i -g grunt-cli
 18```
 19Install all package dependencies.
 20```
 21$ npm install
 22```
 23Now, build TinyMCE by using `grunt`.
 24```
 25$ grunt
 26```
 27
 28
 29Build tasks
 30------------
 31`grunt`
 32Lints, compiles, minifies and creates release packages for TinyMCE. This will produce the production ready packages.
 33
 34`grunt start`
 35Starts a webpack-dev-server that compiles the core, themes, plugins and all demos. Go to `localhost:3000` for a list of links to all the demo pages.
 36
 37`grunt dev`
 38Runs tsc, webpack and less. This will only produce the bare essentials for a development build and is a lot faster.
 39
 40`grunt test`
 41Runs all tests on PhantomJS.
 42
 43`grunt bedrock-manual`
 44Runs all tests manually in a browser.
 45
 46`grunt bedrock-auto:<browser>`
 47Runs all tests through selenium browsers supported are chrome, firefox, ie, MicrosoftEdge, chrome-headless and phantomjs.
 48
 49`grunt webpack:core`
 50Builds the demo js files for the core part of tinymce this is required to get the core demos working.
 51
 52`grunt webpack:plugins`
 53Builds the demo js files for the plugins part of tinymce this is required to get the plugins demos working.
 54
 55`grunt webpack:themes`
 56Builds the demo js files for the themes part of tinymce this is required to get the themes demos working.
 57
 58`grunt webpack:<name>-plugin`
 59Builds the demo js files for the specific plugin.
 60
 61`grunt webpack:<name>-theme`
 62Builds the demo js files for the specific theme.
 63
 64`grunt --help`
 65Displays the various build tasks.
 66
 67Bundle themes and plugins into a single file
 68---------------------------------------------
 69`grunt bundle --themes=modern --plugins=table,paste`
 70
 71Minifies the core, adds the modern theme and adds the table and paste plugin into tinymce.min.js.
 72
 73Contributing to the TinyMCE project
 74------------------------------------
 75TinyMCE is an open source software project and we encourage developers to contribute patches and code to be included in the main package of TinyMCE.
 76
 77__Basic Rules__
 78
 79* Contributed code will be licensed under the LGPL license but not limited to LGPL
 80* Copyright notices will be changed to Ephox Corporation, contributors will get credit for their work
 81* All third party code will be reviewed, tested and possibly modified before being released
 82* All contributors will have to have signed the Contributor License Agreement
 83
 84These basic rules ensures that the contributed code remains open source and under the LGPL license.
 85
 86__How to Contribute to the Code__
 87
 88The TinyMCE source code is [hosted on Github](https://github.com/tinymce/tinymce). Through Github you can submit pull requests and log new bugs and feature requests.
 89
 90When you submit a pull request, you will get a notice about signing the __Contributors License Agreement (CLA)__.
 91You should have a __valid email address on your GitHub account__, and you will be sent a key to verify your identity and digitally sign the agreement.
 92
 93After you signed your pull request will automatically be ready for review & merge.
 94
 95__How to Contribute to the Docs__
 96
 97Docs are hosted on Github in the [tinymce-docs](https://github.com/tinymce/tinymce-docs) repo.
 98
 99[How to contribute](https://www.tinymce.com/docs/advanced/contributing-docs/) to the docs, including a style guide, can be found on the TinyMCE website.
100