diff --git a/README b/README new file mode 100644 index 000000000..51f03d48a --- /dev/null +++ b/README @@ -0,0 +1,68 @@ + +------------------------------------------------------------ + About this README +------------------------------------------------------------ + +This README is intended to provide quick and to-the-point documentation for +technical users intending to compile parts of Guacamole themselves. + +Distribution-specific packages are available from the files section of the main +project page: + + http://sourceforge.net/projects/guacamole/files/ + +Distribution-specific documentation is provided on the Guacamole wiki: + + http://guac-dev.org/ + + +------------------------------------------------------------ + What is guacamole-client? +------------------------------------------------------------ + +guacamole-client is the superproject containing all Maven-based projects that +make Guacamole, an HTML5 web application that provides access to your desktop +using remote desktop protocols. + +guacamole-client is used to build the subprojects that make up Guacamole, and +to provide a common central repository. Each project contained here is +completely independent of guacamole-client and can be built separately, though +the others may have to be built first. If all projects are built using +guacamole-client, Maven will take care of the proper build order. + + +------------------------------------------------------------ + Compiling and installing Guacamole +------------------------------------------------------------ + +Guacamole is built using Maven. Building Guacamole compiles all classes and +packages them into a deployable .war file. This .war file can be installed +and deployed under servlet containers like Apache Tomcat or Jetty. + +1) Run mvn package + + $ mvn package + + Maven will download any needed dependencies for building the .jar file. + Once all dependencies have been downloaded, the .war file will be + created in the guacamole/target/ subdirectory of the current directory. + +2) Copy the .war file as directed in the instructions provided with + your servlet container. + + Apache Tomcat, Jetty, and other servlet containers have specific and + varying locations that .war files must be placed for the web + application to be deployed. + + You will likely need to do this as root. + + +------------------------------------------------------------ + Reporting problems +------------------------------------------------------------ + +Please report any bugs encountered by opening a new ticket at the Trac system +hosted at: + + http://guac-dev.org/trac/ +