+code_swarm is an experiment in organic software visualization.\r
+\r
+See http://vis.cs.ucdavis.edu/~ogawa/codeswarm for a picture of what we want\r
+to produce.\r
+\r
+Google Code Project : http://code.google.com/p/codeswarm/\r
+Google Group/Mailing List: http://groups.google.com/group/codeswarm \r
+\r
+\r
+I) How to build Java code_swarm in different environments.\r
+\r
+Please visit http://code.google.com/p/codeswarm/wiki/HowtoBuild for more \r
+detailed and up-to-date information.\r
+\r
+This quick guide explains how to setup your development environment to build\r
+the binary (ie. jar) version of code_swarm from Java sources.\r
+Explanations require at least an understanding of computing and of your\r
+Operating System, even if no Java skills are needed.\r
+\r
+I.1) Setup\r
+You will need the "Ant" software building tool, and Sun's Java Development Kit,\r
+version 1.5 or later (OpenJDK may work but is untested).\r
+\r
+I.1.a) Linux\r
+This guide is written with a Debian based Linux, Ubuntu 8.04. It requires\r
+some minor adaptation to use on other distribution (other packaging systems).\r
+\r
+ * install ant with the following command (or with your favorite graphical \r
+ package manager):\r
+ sudo apt-get install ant \r
+\r
+ * install sun-java-jdk 1.5 or 1.6 following your distribution recommendation \r
+ sudo apt-get install sun-java6-jdk \r
+\r
+ * configure the Java SDK to specify the new installation path, for instance \r
+ on Ubuntu: \r
+ sudo update-java-alternatives -s java-6-sun \r
+\r
+ See http://doc.ubuntu-fr.org/java\r
+\r
+I.1.b) Windows\r
+ * download ant for all platforms at http://ant.apache.org/bindownload.cgi\r
+\r
+ * unpack it where you want it to be installed, and add the location of\r
+ its binaries to the the "PATH" environment variable. For instance,\r
+ add at the end : "C:\apache-ant-1.7.0\bin;"\r
+\r
+ * download Sun Java SDK at http://java.sun.com/javase/downloads/index.jsp\r
+\r
+ * install it and add the "javac" Java compiler to the PATH : \r
+ "C:\Program Files\Java\jdk1.6.0_06\bin;" \r
+\r
+ * then create a new environment variable called JAVA_HOME and set its path to \r
+ something like "C:\Program Files\Java\jdk1.6.X", where X is the specific\r
+ version number.\r
+\r
+I.2) Getting the sources\r
+\r
+code_swarm sources are under a Google Code Subversion repository (svn) :\r
+http://codeswarm.googlecode.com/svn/trunk/\r
+\r
+See the Subversion homepage on subversion.tigris.org for all appropriate tools \r
+and documents. I would recommend "TortoiseSVN" for Windows users. \r
+Unix-like users should get their native "Subversion" package.\r
+\r
+See http://code.google.com/p/codeswarm/source/ for further instructions on\r
+how to browse and checkout the sources.\r
+\r
+I.3) Building the sources\r
+\r
+Quick build :\r
+ * Open a terminal/command line shell, change directory to the root of\r
+ the code_swarm source folder.\r
+\r
+ * Compile the sources by typing "ant".\r
+\r
+\r
+\r
+\r
+Other commands :\r
+ * "ant all" will also generate the Javadoc HTML sources documentation\r
+ * "ant clean" will delete all intermediate and binary files \r
+\r
+I.4) Running code_swarm\r
+\r
+These instructions are meant to be generic to cover most popular version\r
+control systems.\r
+Please visit http://code.google.com/p/codeswarm/wiki/GeneratingAVideo for more \r
+detailed and up-to-date information.\r
+\r
+ * Obtain the log from your software version control system.\r
+ Save it as a text file.\r
+\r
+ * Convert your log file to the code_swarm XML data format:\r
+ Change directory to "convert_logs."\r
+ Generally, the syntax is:\r
+\r
+ convert_logs.py -Y input_log.txt -o output.xml\r
+\r
+ where -Y is a flag for your particular version control system.\r
+ Type "convert_logs.py --help" for details.\r
+\r
+ * Create your own configuration by copying "data/sample.config" and editing \r
+ it to your preferences.\r
+\r
+ * To launch code_swarm, type "run.bat" in Windows or "run.sh" in Unix.\r
+ You will be prompted for the config file from the previous step.\r
+\r
+ * If you have specified TakeSnapshots=true in the config, saved images\r
+ will be in the "frames" directory.\r
projects / mailer.git / blobdiff