Skip to content

Commit 5d0c492

Browse files
author
rcartwright
committed
This commit contains an updated README file which was last edited by Charles Reis several years ago. The following file was modified:
M README git-svn-id: file:///tmp/test-svn/trunk@4465 fe72c1cf-3628-48e9-8b72-1c46755d3cff
1 parent bc2858e commit 5d0c492

File tree

1 file changed

+16
-77
lines changed

1 file changed

+16
-77
lines changed

‎drjava/README‎

Lines changed: 16 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -11,94 +11,33 @@ http://drjava.sf.net/devdocs/
1111

1212
-------------------------------------------------------------------------------
1313

14-
Quick Environment Setup Instructions
15-
by Brian Stoler (bstoler@rice.edu), Charles Reis (creis@rice.edu)
14+
QuickStart Guilde For Building DrJava
15+
by Corky Cartwright (cork@rice.edu)
1616

17-
1) Get SourceForge.net account and get added to the DrJava group.
17+
The following guide presumes that you already have a Java 5.0 or 6.0 SDK, subversion (svn) 1.4 or above, and ant 1.7 or above installed on your machine. If not, follow the instructions at http://www.drjava.org/devdocs/ for setting up a DrJava development environment.
1818

19-
2) Make a directory to be the top-level container of DrJava stuff. I recommend
20-
"drjava".
19+
1) Make a directory to be the top-level container for you drjava code tree. I recommend "drjava".
2120

22-
3) Set CVSROOT environment variable to "user@cvs.drjava.sf.net:/cvsroot/drjava",
23-
substituting your SourceForge account name for user.
21+
2) Descend into this new directory by typing the command
2422

25-
4) Set CVS_RSH environment variable to "ssh"
23+
cd ~/drjava
2624

27-
5) cd ~/drjava
25+
3) Download the drjava source code base by typing the command
2826

29-
6) cvs -d $CVSROOT checkout src
27+
svn co https://drjava.svn.sourceforge.net/svnroot/drjava/trunk/drjava
3028

31-
7) Install Ant (version 1.5.1 or later): http://jakarta.apache.org/ant
29+
4) After this download completes, descend into the root directory of the dowloaded code base by typing the command
3230

33-
8) Download the JSR-14 prototype compiler (with generics) from
34-
http://developer.java.sun.com/developer/earlyAccess/adding_generics.
35-
Then unzip the file you downloaded, and move the included javac.jar to
36-
~/drjava/src/edu/rice/cs/lib/jsr14.jar.
37-
(Note that if you download JSR-14 v1.3, you will need Java 1.4.1.)
31+
cd ~/drjava
3832

39-
9) Set CLASSPATH environment variable to include all of the following:
40-
* ~/drjava/built (this is where compiled classes will go)
41-
* ~/drjava/src/edu/rice/cs/lib/jsr14.jar
42-
* ~/drjava/src/edu/rice/cs/lib/junit.jar
43-
* ~/drjava/src/edu/rice/cs/lib/GJv6.jar
44-
* ~/drjava/src/edu/rice/cs/lib/gj-util.jar
45-
* ~/drjava/src/edu/rice/cs/lib/dynamicjava.jar
46-
* ~/drjava/src/edu/rice/cs/lib/compilers-jsr14v1_0.jar
47-
* ~/drjava/src/edu/rice/cs/lib/compilers-jsr14v1_2.jar
48-
* The tools.jar file in your JDK's lib directory
33+
5) To compile the code base and generate a jar file containing the compiled program, enter the command
4934

50-
That should be it! Make sure all the environment variables are exported if
51-
you're using UNIX. Of course you'll probably want to set them from within
52-
a script or your .bashrc or .cshrc or whatever.
35+
ant jar
5336

37+
which builds a jar filed named drjava-15.jar
5438

55-
To compile the classes:
39+
If the build is successful, you can execute the built program by entering the command
5640

57-
1) Change to the src/edu/rice/cs/util/ directory.
41+
java -jar drjava-15.jar
5842

59-
2) Run "ant clean compile"
60-
61-
3) Change to the src/edu/rice/cs/drjava/ directory.
62-
63-
4) Run "ant clean compile"
64-
65-
5) Start DrJava with "java edu.rice.cs.drjava.DrJava" or "ant run"
66-
67-
68-
-------------------------------------------------------------------------------
69-
70-
Some potential problems and their solutions
71-
-------------------------------------------
72-
Problem: You get an OutOfMemoryError when compiling or testing
73-
Solution: Increase the maximum JVM memory size for the JVM Ant uses.
74-
To do this, add to ANT_OPTS "-XmxSIZE", where SIZE is the size you'd like.
75-
(See "Setting ANT_OPTS" below.)
76-
77-
Problem: Compiling DrJava gives errors at definitions involving parametric
78-
types
79-
Solution: Put jsr14.jar in the bootclasspath. The DrJava build
80-
script automatically puts JSR14 into the classpath when compiling, and
81-
usually this works just fine. Sometimes (I've seen it only on MacOS X so
82-
far), this doesn't work. (On MacOS, it's because the standard
83-
bootclasspath already contains a copy of javac.) To get around this, we
84-
must put jsr14.jar in the bootclasspath of Ant's JVM. To do this, add to
85-
ANT_OPTS "-Xbootclasspath/p:PATH", where PATH is the full path to
86-
jsr14.jar (which should be $HOME/sf/src/edu/rice/cs/lib/jsr14.jar).
87-
(See "Setting ANT_OPTS" below.)
88-
89-
Setting ANT_OPTS ----------------
90-
The contents of the environment variable ANT_OPTS are automatically put on
91-
the command line when invoking the JVM by Ant. There are three ways to set
92-
this variable: You can set it manually from the shell, you can set it
93-
automatically in your shell's startup file (.profile or .cshrc), or you
94-
can set it from within .antrc. .antrc is loaded by the ant shell script
95-
before invoking the JVM. Since ant is an sh shell script, .antrc must also
96-
be of that form. Here you can put in a line like this, for example, to set
97-
the maximum heap size to 256MB:
98-
99-
ANT_OPTS="$ANT_OPTS -Xmx256M"
100-
101-
-------------------------------------------------------------------------------
102-
To view the most current version of this document in your Web browser, go to:
103-
104-
http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/drjava/src/edu/rice/cs/README?rev=HEAD&content-type=text/vnd.viewcvs-markup
43+
If you encounter any problems, consult the Developer Docs at drjava.org by visiting http://www.drjava.org/devdocs/.

0 commit comments

Comments
 (0)