Skip to content

Commit

Permalink
Added github compatible readme and .gitignore/.gitattributes
Browse files Browse the repository at this point in the history
  • Loading branch information
spocke committed Jan 13, 2010
1 parent 4011222 commit 85a83f6
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* crlf=input
21 changes: 21 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
bin
obj
tmp
docs
.settings
*~
*.diff
*.patch
*.bak
*.log
.DS_Store
editor_plugin.js
editor_template.js
jscripts/tiny_mce/jquery.tinymce.js
jscripts/tiny_mce/tiny_mce.js
jscripts/tiny_mce/tiny_mce_jquery.js
jscripts/tiny_mce/tiny_mce_jquery_src.js
jscripts/tiny_mce/tiny_mce_popup.js
jscripts/tiny_mce/tiny_mce_prototype.js
jscripts/tiny_mce/tiny_mce_prototype_src.js
jscripts/tiny_mce/tiny_mce_src.js
29 changes: 29 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
TinyMCE - The JavaScript Rich Text editor
=========================================

What you need to build TinyMCE
-------------------------------
* Install the Java JDK or JRE packages you can find it at: http://java.sun.com/javase/downloads/index.jsp
* Install Apache Ant you can find it at: http://ant.apache.org/
* Add Apache Ant to your systems path environment variable, this is not required but makes it easier to issue commands to Ant without having to type the full path for it.

How to build TinyMCE
---------------------

In the root directory of TinyMCE where the build.xml file is you can run ant against different targets.

`ant`

Will combine, preprocess and minify the TinyMCE classes into tiny_mce.js and tiny_mce_src.js and it's jQuery variant.

`ant moxiedoc`

Will generate API Documentation for the project using the Moxiedoc tool. The docs will be generated to the docs/api directory.

`ant release`

Will produce an release package of the current repository code. The release package will be placed in the export directory. Release packages will be placed in the tmp directory.

Contributing to the TinyMCE project
------------------------------------
You can read more about how to contribute to this project at http://tinymce.moxiecode.com/contributing

0 comments on commit 85a83f6

Please sign in to comment.