f10963b06a8da099c54514b9f548b8d25006ebde
[mailer.git] / code_swarm / README
1 code_swarm is an experiment in organic software visualization.\r
2 \r
3 See http://vis.cs.ucdavis.edu/~ogawa/codeswarm for a picture of what we want\r
4 to produce.\r
5 \r
6 Google Code Project :      http://code.google.com/p/codeswarm/\r
7 Google Group/Mailing List: http://groups.google.com/group/codeswarm \r
8 \r
9 \r
10 I) How to build Java code_swarm in different environments.\r
11 \r
12 Please visit http://code.google.com/p/codeswarm/wiki/HowtoBuild for more \r
13 detailed and up-to-date information.\r
14 \r
15 This quick guide explains how to setup your development environment to build\r
16 the binary (ie. jar) version of code_swarm from Java sources.\r
17 Explanations require at least an understanding of computing and of your\r
18 Operating System, even if no Java skills are needed.\r
19 \r
20 I.1) Setup\r
21 You will need the "Ant" software building tool, and Sun's Java Development Kit,\r
22 version 1.5 or later (OpenJDK may work but is untested).\r
23 \r
24 I.1.a) Linux\r
25 This guide is written with a Debian based Linux, Ubuntu 8.04. It requires\r
26 some minor adaptation to use on other distribution (other packaging systems).\r
27 \r
28  * install ant with the following command (or with your favorite graphical \r
29    package manager):\r
30      sudo apt-get install ant \r
31 \r
32  * install sun-java-jdk 1.5 or 1.6 following your distribution recommendation \r
33     sudo apt-get install sun-java6-jdk \r
34 \r
35  * configure the Java SDK to specify the new installation path, for instance \r
36    on Ubuntu: \r
37      sudo update-java-alternatives -s java-6-sun \r
38 \r
39    See http://doc.ubuntu-fr.org/java\r
40 \r
41 I.1.b) Windows\r
42  * download ant for all platforms at http://ant.apache.org/bindownload.cgi\r
43 \r
44  * unpack it where you want it to be installed, and add the location of\r
45    its binaries to the the "PATH" environment variable. For instance,\r
46    add at the end : "C:\apache-ant-1.7.0\bin;"\r
47 \r
48  * download Sun Java SDK at http://java.sun.com/javase/downloads/index.jsp\r
49 \r
50  * install it and add the "javac" Java compiler to the PATH : \r
51    "C:\Program Files\Java\jdk1.6.0_06\bin;" \r
52 \r
53  * then create a new environment variable called JAVA_HOME and set its path to \r
54    something like "C:\Program Files\Java\jdk1.6.X", where X is the specific\r
55    version number.\r
56 \r
57 I.2) Getting the sources\r
58 \r
59 code_swarm sources are under a Google Code Subversion repository (svn) :\r
60 http://codeswarm.googlecode.com/svn/trunk/\r
61 \r
62 See the Subversion homepage on subversion.tigris.org for all appropriate tools \r
63 and documents. I would recommend "TortoiseSVN" for Windows users. \r
64 Unix-like users should get their native "Subversion" package.\r
65 \r
66 See http://code.google.com/p/codeswarm/source/ for further instructions on\r
67 how to browse and checkout the sources.\r
68 \r
69 I.3) Building the sources\r
70 \r
71 Quick build :\r
72  * Open a terminal/command line shell, change directory to the root of\r
73    the code_swarm source folder.\r
74 \r
75  * Compile the sources by typing "ant".\r
76 \r
77 \r
78 \r
79 \r
80 Other commands :\r
81  * "ant all" will also generate the Javadoc HTML sources documentation\r
82  * "ant clean" will delete all intermediate and binary files \r
83 \r
84 I.4) Running code_swarm\r
85 \r
86 These instructions are meant to be generic to cover most popular version\r
87 control systems.\r
88 Please visit http://code.google.com/p/codeswarm/wiki/GeneratingAVideo for more \r
89 detailed and up-to-date information.\r
90 \r
91  * Obtain the log from your software version control system.\r
92    Save it as a text file.\r
93 \r
94  * Convert your log file to the code_swarm XML data format:\r
95      Change directory to "convert_logs."\r
96      Generally, the syntax is:\r
97 \r
98          convert_logs.py -Y input_log.txt -o output.xml\r
99 \r
100      where -Y is a flag for your particular version control system.\r
101      Type "convert_logs.py --help" for details.\r
102 \r
103  * Create your own configuration by copying "data/sample.config" and editing \r
104    it to your preferences.\r
105 \r
106  * To launch code_swarm, type "run.bat" in Windows or "run.sh" in Unix.\r
107    You will be prompted for the config file from the previous step.\r
108 \r
109  * If you have specified TakeSnapshots=true in the config, saved images\r
110    will be in the "frames" directory.\r