Some cleanup by Eclipse
[online-glom:gwt-glom.git] / README
1 gwt-glom is a web UI for Glom database systems.
2 See http://www.glom.org
3
4 ** Source Code:
5
6 gwt-glom is in git:
7 http://gitorious.org/online-glom/gwt-glom
8
9 ** Building:
10
11 You will need to install mvn (maven), 
12 Maven will download other Java dependencies automatically.
13
14 To build the .war package, do:
15   mvn clean package
16
17 To see test reports, and other stuff, by doing:
18   mvn site
19 and then viewing target/site/index.html in your browser.
20
21
22 More documentation is on the glom wiki:
23 http://www.glom.org/wiki/index.php?title=Development/OnlineGlom
24
25
26 *** Building the source tarball ***
27
28 To build a source tarball, do:
29   mvn assembly:single
30
31 This uses the maven-assembly-plugin, which is configured (in pom.xml) to use 
32 our assembly.xml file.
33
34
35 *** Notes:
36
37 We are using the default GWT compilation option of compiling the Java code to
38 obfuscated JavaScript. The reason for this is covered by this snippet from the
39 GWT developer docs:
40
41 “obfuscation reduces the size of the generated JavaScript files, making them
42 faster to download and parse”
43
44 https://code.google.com/webtoolkit/doc/latest/FAQ_DebuggingAndCompiling.html