build documentation (on wiki) is out of date #1629
Comments
|
I've fixed the Eclipse section, though it could use more detail/screenshots to explain how to get the beast running. But at least it's not longer wildly inaccurate. The rest of the command line stuff needs to be explained in more detail. It's much simpler than it all looks, but we do need better instructions. |
|
Yeah I was planning on updating it. First step was to move everything over, which I did yesterday. We can definitely collaborate on this. The good news is that it looks like the process is a lot simpler, just running @ybakos I'm on OS X, if you're on Windows or Linux, maybe we could split the work that way. |
|
Ok. I'd like to casually suggest the goal of the build instructions to be I've confirmed that this works on OSX 10.7.3. I'll work on linux and windows today. |
|
No issues on WIn7/8. Testing linux (Ubuntu) now. I feel that the document should explain pre-requisites (java7, ant, paths correctly set up) but not describe steps to getting those things set up. |
|
I've made an effort here: https://github.com/processing/processing/wiki/Build-Instructions-(Updated) |
|
@benfry @prisonerjohn What do you think about starting with this: https://gist.github.com/ybakos/5008910 We can add visual aids to the Eclipse section later. |
|
Perhaps we shouldn't use the github wiki at all? That way all Processing doco is in one place, on wiki.processing.org. Maybe place bare-minimum build instructions in the README. |
|
@ybakos For now, we want to use both. All development information (tools, library, and main project) should be on the GitHub wikis and the Processing wiki should have clear links to GitHub. We need the GitHub wiki to help developers find the information they need easily and we need the Processing wiki for additional information, not related to development. (We're currently talking about phasing out the Processing wiki.) |
|
Would like to add for the Eclipse section, to actually run the IDE in Eclipse for debugging I had to change the working directory to \build\windows\work for it to run. Not sure if that's common for everyone using Eclipse on Windows but might be worth adding. (Took me a couple hours to hunt down where it was expecting to look.) |
|
Yep, when running from Eclipse (for any platform) the working directory needs to be 'work'. Using Eclipse is simply not documented at the moment. I use it for development, but we're not committed to that being a development path or that always working out of the box. |
|
Ok. I'll add that as a note to the Eclipse section of the build page. (Every little bit helps, hopefully) |
|
@joshgiesbrecht Yes, help to keep this all updated is very appreciated. The Wiki is open for the community to contribute. If you don't have an account there yet, there are instructions on the first page. |
|
@joshgiesbrecht , @benfry - setting the working directory to 'work' doesn't work on my Mac. I get an error message ("Could not read default settings. You'll need to reinstall Processing." followed by However, if I set the working directory to /Users/datguy/git/processing/build/macosx/work/Processing.app/Contents/Resources/Java (after building with ant) it works. What am I doing wrong? |
|
Since my name's there, I'll just pop in to say ... I don't really know. :) I haven't used Eclipse that much, I was just happy to get it to work for myself! |
|
I've been looking at the 3 versions of Build-Instructions (the current page, plus the ones proposed by @Manindra29 and @ybakos). They all say you need Java 1.7, but most of compile steps in the build.xml files specify 1.6. Is 1.7 really required, or should we change the wiki to be consistent with the build scripts? |
|
AFAIK as long as the java source and target versions are specified in the build.xml(Processing uses 1.6), compiling with even Java 1.7 produces output compatible with Java 1.6. So w.r.t building Processing, having the latest version of Java shouldn't be an issue. Not sure if this applies to OS X though. |
|
I agree that the output should be compatible, but technically it's inaccurate to say that 1.7 is required if we're specifying 1.6 compatibility. I suggest that the build page(s) specify 1.6 or later until 1.7 is actually required. |
|
I updated the build doc, thanks @datguy. |
|
Not sure if this is the correct place for this question, but I was able to build OK with ant and in Eclipse on OSX 10.6.8. I was able to solve the preferences.txt issue above with a sym-link, but now I'm getting another error (when I run in Eclipse) that I'm not sure about: "FileNotFoundException: /Users/dhowe/git/processing/app/modes/java/keywords.txt" Seems maybe the modes haven't been built properly... though they are present in path/to/processing/build/macosx/work/Processing.app/Contents/Java/modes Any thoughts? |
|
@dhowe please use the forum to ask questions. This is an issue report about the need to update the build instructions. |
|
@benfry unless things have changed in the new forum, there isn't a good place there to ask questions about building or contributing to Processing. |
|
@datguy Then start one. But filling a bug report about fixing the build instructions is not the place for random questions about the builds. |
|
The new forum categories have a section called Developing Processing: |
|
Build instructions now updated, and also include the changes for 2.1. |
|
Shouldn't that first bullet be "install the latest JDK 7 from Oracle" instead of "JRE"? |
|
No, read the rest of it. |
|
You reference this as current from README.md but closed it last month? Should README.md be updated? |
|
This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
https://github.com/processing/processing/wiki/Build-Instructions
This is an issue for discussing updates to the build doc, which is something I'm actively working on.
@prisonerjohn: Elie, let me know if you're already on this and/or we can collaborate on parts.
Let's make this doc "real nice".
The text was updated successfully, but these errors were encountered: