-
Notifications
You must be signed in to change notification settings - Fork 0
Build Instructions
If you have questions about the contents of this document, ask them in the forum.
We moved this document over from Google Code. It is probably out of date. See the comments on that page for troubleshooting and solutions.
The big change is that you'll be cloning the “processing” repo from here on Github, but after that, the Update from 2010 (directly below) should be most of what's needed.
- I'm in the midst of moving the build system over to ant, but haven't yet had time to update this document. For the most part, as long as you have a JDK installed, and Ant installed as well, you should be able to
cdtoprocessing/buildand typeant runto get things going. - On Windows and Linux, install ant and add
c:\apache-ant-xxx\bindirectory to your path. On Mac OS X, you'll have ant as long as the Developer Tools are already installed. - On Windows and Linux, you'll need to set a
JAVA_HOMEenvironment variable that points to the root of a full JDK (not JRE).
- As noted on the front page of this site, we're now heading toward 2.0, and things are really messy inside SVN as a result. Use of the source is not for the fainthearted (or those prone to whining about the progress of hard work that others are doing in their spare time).
- An error message that reads "Unable to locate tools.jar. Expected to find it in C:\Program Files\Java\jre6\lib\tools.jar" means you need to set
JAVA_HOMEto your JDK (not JRE) installation. Build errors regarding a lot of missing classes for processing.app.debug mean that JAVA_HOME is not set properly. - Sometimes the build claims that it needs the Android SDK to be installed. If you're running
ant dist(which you shouldn't anyway) it is required. If you're not, then it's a temporary problem in the build files and probably needs to be reported as a bug.
More to come...
- Download and install the following. Follow the instructions on their respective pages for how to install.
- Subversion
- Apache Ant
-
Java 6 – Be sure you get the full JDK, not the JRE. I recommended you install it into somewhere like
c:\jdk-1.6.0_26, to make it easier to refer to in the next step.
- Set environment variables.
- On Windows XP, right-click My Computer → Properties → Advanced. On Windows 7, use Start → Control Panel → System → Advanced System Settings. On both, next click Environment Variables.
- You'll need to add the
binfolder from apache-ant-1.8.2 to yourPATH. Under "User variables" click New, and enterPATHfor the variable name, and%PATH%;c:\apache-ant-1.8.2\binor replace theC:\part with wherever you've installed Ant. - Set a
JAVA_HOMEenvironment variable to the location of the folder where the JDK is installed. Click New again, enterJAVA_HOME, and thenc:\jdk-1.6.0_26(if you followed the recommendation above) or include the full path for wherever you installed the JDK.
- Open a new Command Prompt so that it picks up the variables you just changed.
- Next download the code by typing this from a prompt:
svn checkout http://processing.googlecode.com/svn/trunk/processing processing-read-only
- Now build the beast. In the Command Prompt,
cdto theprocessing/build, and type:
ant run
- With any luck, Processing should start right up and you'll be on your way.
- To update to the latest, cd to the root
processingfolder, and type:
svn up
Updated 24 June 2011
These are the old instructions, but are still partially true and may offer clues.
Install Cygwin. It's downloadable from here. Be sure to select "Unix line endings" in the installer. When asked for packages, begin with the defaults, and add:
-
subversion– for version control -
make,gcc-mingw, andg++– to build processing.exe (this will also pull in gcc-core) -
perl– use this version from cygwin, activestate or other windows perl distributions have trouble -
unzip,zip– for dealing with archives -
coreutils,gzip,tar– should be included in the defaults, but make sure -
openssh– not required, but useful command line ssh client -
nano– not required, but a handy/simple text editor (gnupicoripoff)
Again, be sure to leave the option selected for 'Unix line endings'. If you're not using Cygwin, then be sure to find the preference in your SVN client.
The Cygwin installer is sometimes a little flaky, so it may take more than one try to get everything in there. In fact, it's often best to run the installer once, and let it install all its defaults, then run it again, and select the items above. It's also useful to run the installer every few months to keep things fresh.
Install Apple's Developer Tools (Xcode). You'll also need Subversion. Install it from Fink, Darwinports, or download as a package.
You're pretty much on your own.. You need a pretty standard development setup along with Subversion.
As of June 2010, we've moved the repository to Google Code.
To get the code, type this from a prompt:
svn checkout http://processing.googlecode.com/svn/trunk/ processing-read-only
That part may take a while, especially for people outside the US or who have a slow internet connection. (The JRE binaries are stored in SVN so that we can properly test on the exact platform/runtime setup that we'll be releasing. No longer the case.)
You'll also need to install QuickTime for Java. Grab the QuickTime (and iTunes) installer from here or a version that doesn't include iTunes from here. As of QuickTime 7 (iTunes 6), QuickTime for Java is mercifully included by default.
QuickTime 6 is no longer supported. QuickTime Alternative has never been supported. Just use QuickTime 7.
Now to build for the first time:
cd /path/to/processing/build/windows
Or if you're on Linux:
cd /path/to/processing/build/linux
Let's say you're into black turtlenecks and jeans:
cd /path/to/processing/build/macosx
And then..
./make.sh
If everything went well, you'll have no errors. (Feel free to make suggestions for things to include here for common problems.)
Then to run:
./run.sh
Each time you make a change, use make to build the thing and run to get it up and running.
Each time you want to update to latest version:
cd /path/to/processing
svn update
If you're getting strange errors when you try to build, especially if new folders have been added to the Processing repository, remove your work folder and rebuild. Generally, this is a good idea to do whenever a new release has been made, since that will involve files that may have been changed (or folders that have been moved).
Get to the processing folder:
cd /path/to/processing
Remove the work directory:
cd build/yourplatform
rm -rf work
And try again
./make.sh
Unfortunately there isn't a way to know if new folders have since been added. But if you're getting "class not found" errors while building, then that's a good indicator that something is missing from a subfolder.
Disclaimer: Processing is intended to be built with ant. You should always ensure the code compiles with ant before submitting a pull request.
-
Open Eclipse, select File → Import... Expand the “Git” folder, select “Projects from Git”, and hit the Next button.
-
On the “Select Repository Source” screen, choose “URI” and enter https://github.com/processing/processing.git And then click Next.
-
Select “Import existing projects” on the “Wizard for project import” page. Hit Next.
-
Select all the projects shown and finish the wizard.
-
You'll have several errors, because you need to build the projects once with ant (on the command line: cd /path/to/processing/build && ant) so that the “generated” folder is created. After doing that, select the processing-app project in Eclipse and hit F5 to refresh it.
-
You'll need to set an ANDROID_LIB classpath variable (Preferences > Java > Build Path > Classpath Variables), that points at the android.jar file for SDK 10. i.e. /path/to/android-sdk/platforms/android-10/android.jar
-
Make sure that you're using a full JDK to build, otherwise you'll get errors about missing com.sun.jdi.* classes.
-
For bonus points, you can also set
processing/build/formatter.xmlas the code formatter for your workspace. -
Be sure to the execution environment is set to Java 1.6, since that's what's used for the PDE. There are no plans to move to 1.7 anytime soon.