1Plupload - Cross browser and platform uploader API
2===================================================
3
4What is Plupload
5-----------------
6Plupload is a JavaScript API for dealing with file uploads it supports features like multiple file selection, file type filtering,
7request chunking, client side image scaling and it uses different runtimes to achieve this such as HTML 5, Silverlight, Flash, Gears and BrowserPlus.
8
9What you need to build Plupload
10-------------------------------
11* Install the Java JDK or JRE packages you can find it at: [http://java.sun.com/javase/downloads/index.jsp](http://java.sun.com/javase/downloads/index.jsp)
12* Install Apache Ant you can find it at: [http://ant.apache.org/](http://ant.apache.org/)
13* 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.
14
15How to build Plupload
16----------------------
17
18In the root directory of Plupload where the build.xml file is you can run ant against different targets.
19
20`ant`
21
22Will combine, preprocess and minify the Plupload classes into the js directory. It will not build the Silverlight and Flash .xap and .swf files.
23
24`ant moxiedoc`
25
26Will generate API Documentation for the project using the Moxiedoc tool. The docs will be generated to the docs/api directory.
27
28`ant release`
29
30Will produce release packages. The release packages will be placed in the tmp directory.
31
32How to build Flash runtime
33---------------------------
34The Flash runtime uses a .swf file that can be built using the Flex SDK. This SDK can be downloaded from Adobe. [http://www.adobe.com/devnet/flex/flex-sdk-download.html](http://www.adobe.com/devnet/flex/flex-sdk-download.html)
35
36How to build Silverlight runtime
37---------------------------------
38The Silverlight runtime uses a .xap file that can be built using the Silverlight SDK or Visual Studio. [http://silverlight.net/getstarted/](http://silverlight.net/getstarted/)
39
40Running the development version
41--------------------------------
42The unminified development version of the javascript files can be executed by opening the examples/queue_widget_dev.html file running on a Web Server.
43
44Contributing to the Plupload project
45-------------------------------------
46You can read more about how to contribute to this project at [http://www.plupload.com/contributing](http://www.plupload.com/contributing)
47