Skip to content

Commit feb87eb

Browse files
committed
Added information about JAVA_HOME to README.md
1 parent 37493e1 commit feb87eb

File tree

1 file changed

+23
-4
lines changed

1 file changed

+23
-4
lines changed

java_generate/README.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,22 +14,41 @@ In other words, the two repositories should live side-by-side:
1414
- base_dir/processing-web/
1515

1616
### Running java-generate
17+
The documentation is build using a command-line script.
18+
```
1719
$ cd ReferenceGenerator/
1820
$ ./processingrefBuild.sh
21+
```
1922

2023
### Building the Java-Generate classes
2124

2225
Java-generate is compiled using ant, which is likely already installed on your machine.
23-
To build the
26+
To build the reference generator
27+
28+
```bash
2429
$ cd ReferenceGenerator/
2530
$ ant compile
31+
```
2632

2733
For more information on ant, see http://ant.apache.org
2834

35+
If you have trouble compiling with ant, you may need to install the JDK on your machine
36+
and add a JAVA_HOME environment variable to your machine. Properly locating your JDK is
37+
essential for handling issues like importing the javadoc package.
38+
39+
On OSX (Mavericks), that will look like the following:
40+
```bash
41+
# in e.g. ~/.bash_profile
42+
# tell Java where to find JDK and libraries
43+
export JAVA_HOME=/Library/Java/JavaVirtualMachines/jdk1.7.0_51.jdk/Contents/Home
44+
```
45+
2946
### Tips & Tricks
3047

3148
When a method is overloaded, but you don't want one of the variants to appear in the reference, add a `@nowebref` comment to the source above that variant. For example:
3249

33-
/**
34-
* @nowebref
35-
*/
50+
```java
51+
/**
52+
* @nowebref
53+
*/
54+
```

0 commit comments

Comments
 (0)