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 However, you must separately install the shared library part of java-libglom.
15 for instance, for Ubuntu via the libjava-libglom-java package 
16 from the PPA for stable releases:
17   https://launchpad.net/~openismus-team/+archive/ppa
18 or from the PPA for unstable releases:
19   https://launchpad.net/~openismus-team/+archive/openismus-glom-unstable/+packages
20
21 To build the .war package, do:
22   mvn clean package
23
24 To see test reports, and other stuff, by doing:
25   mvn site
26 and then viewing target/site/index.html in your browser.
27
28
29 More documentation is on the glom wiki:
30 http://www.glom.org/wiki/index.php?title=Development/OnlineGlom
31
32
33 *** Building the source tarball ***
34
35 To build a source tarball, do:
36   mvn assembly:single
37
38 This uses the maven-assembly-plugin, which is configured (in pom.xml) to use 
39 our assembly.xml file.
40
41
42 *** Notes:
43
44 We are using the default GWT compilation option of compiling the Java code to
45 obfuscated JavaScript. The reason for this is covered by this snippet from the
46 GWT developer docs:
47
48 “obfuscation reduces the size of the generated JavaScript files, making them
49 faster to download and parse”
50
51 https://code.google.com/webtoolkit/doc/latest/FAQ_DebuggingAndCompiling.html