2 ------------------------------------------------------------
4 ------------------------------------------------------------
6 This README is intended to provide quick and to-the-point documentation for
7 technical users intending to compile parts of Guacamole themselves.
9 Distribution-specific packages are available from the files section of the main
12 http://sourceforge.net/projects/guacamole/files/
14 Distribution-specific documentation is provided on the Guacamole wiki:
19 ------------------------------------------------------------
20 What is guacamole-common-js?
21 ------------------------------------------------------------
23 guacamole-common-js is the core JavaScript library used by the Guacamole web
26 guacamole-common-js provides an efficient HTTP tunnel for transporting
27 protocol data between JavaScript and the web application, as well as an
28 implementation of a Guacamole protocol client and abstract synchronized
32 ------------------------------------------------------------
33 Compiling and installing guacamole-common-js
34 ------------------------------------------------------------
36 guacamole-common-js is built using Maven. Note that this is JavaScript code
37 and not actually compiled. "Building" guacamole-common-js actually simply
38 packages it into a redistributable .zip file. This .zip file can be easily
39 included and expanded into other Maven-based projects (like Guacamole).
41 Note that prebuilt versions of guacamole-common-js are available from the
42 main guac-dev.org Maven repository which is referenced in all Maven
43 projects in Guacamole. Unless you want to make changes to guacamole-common-js
44 or you want to use a newer, unreleased version (such as the unstable branch),
45 you do not need to build this manually. You can let Maven download it for
46 you when you build Guacamole.
52 Maven will download any needed dependencies for building the .zip file.
53 Once all dependencies have been downloaded, the .zip file will be
54 created in the target/ subdirectory of the current directory.
60 DO NOT RUN THIS AS ROOT!
62 Maven will install guacamole-common-js to your user's local Maven
63 repository where it can be used in future builds. It will not install
64 into a system-wide repository and does not require root privileges.
66 Once installed, building other Maven projects that depend on
67 guacamole-common-js (such as Guacamole) will be possible.
70 ------------------------------------------------------------
72 ------------------------------------------------------------
74 Please report any bugs encountered by opening a new ticket at the Trac system
77 http://guac-dev.org/trac/