Skip to content

Commit 4aa36ab

Browse files
committed
Improved the README a bit
1 parent 1333451 commit 4aa36ab

File tree

1 file changed

+8
-17
lines changed

1 file changed

+8
-17
lines changed

README.markdown

Lines changed: 8 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,15 @@ Google Group/Mailing List: http://groups.google.com/group/codeswarm
99

1010
# Building #
1111

12-
More detail is available at http://code.google.com/p/codeswarm/wiki/HowtoBuild
13-
14-
This quick guide explains how to setup your development environment to build
15-
and run code_swarm.
16-
17-
1812
## Prerequisites ##
1913

20-
You will need Apache's "ant" build tool, at least version 5 of the Java SDK from Sun, and for some features, Python version 2.4 or later.
21-
14+
You will need Apache's "ant" build tool, at least version 5 of the Java SDK from Sun, and for some features, Python version 2.4 or later. Linux users: we've been unable to get code_swarm to run under the GNU jvm, Sun's jvm is strongly recommended.
2215

2316

2417
### Linux ###
2518

26-
This guide is written with a Debian based Linux, Ubuntu 8.04. The process is likely
27-
to be similar with other linux distributions.
19+
These instructions were tested with Ubuntu 8.04, the process is probably
20+
similar to other linux distributions.
2821

2922
This should ensure that ant and java6 are installed and configured:
3023

@@ -59,8 +52,6 @@ If you have DarwinPorts/MacPorts, you can simply:
5952

6053
## Getting the source code ##
6154

62-
code_swarm is still a very young project. At the moment, the best way to get it going is to download the source code and build it.
63-
6455
### git ###
6556

6657
A git fork of the main code_swarm repository is maintained at <http://github.com/rictic/code_swarm/tree/master>
@@ -84,16 +75,16 @@ Unix-like users would get their native "Subversion" package.
8475
For more information, see http://code.google.com/p/codeswarm/source/checkout
8576

8677

87-
## Building and Running ##
78+
## Running code_swarm ##
8879

89-
With Java and ant installed, and the `code_swarm` source downloaded, running `code_swarm` on any given git, svn, or hg based project is quite easy.
80+
With Java and ant installed, and the code_swarm source downloaded, running it on a git, svn, or hg based project is easy:
9081

9182
* Add `code_swarm/bin` to your PATH. A line like `export PATH=$PATH:/path/to/code_swarm/bin` in your `~/.profile` or `~/.bash_profile` should do it
92-
* `$ cd project/to/visualize`
93-
* `$ code_swarm`
83+
* `cd project/to/visualize`
84+
* `code_swarm`
9485

9586

96-
### Other ways of running code_swarm ###
87+
## Other ways of running code_swarm ##
9788

9889
There are a couple of other ways of invoking code_swarm. For an experimental GUI where you can specify a svn url to visualize:
9990

0 commit comments

Comments
 (0)