Revision: 989 Author: heue...@gmail.com Date: Wed Mar 10 19:01:55 2010 Log: Created wiki page through web user interface. http://code.google.com/p/piccolo2d/source/detail?r=989
Added: /wiki/Readme.wiki ======================================= --- /dev/null +++ /wiki/Readme.wiki Wed Mar 10 19:01:55 2010 @@ -0,0 +1,107 @@ +#summary Piccolo2D.Java Readme. +#labels Featured + +=Piccolo2D.Java Readme= + +This is the Piccolo2D.Java README file + +===INTRODUCTION=== + +Welcome to Piccolo2D! Piccolo2D is a revolutionary way (in the Jazz ZUI +tradition) to create robust, full-featured graphical applications in +Java, with striking features such as zooming and multiple representation. +Piccolo2d.Java is an extensive toolkit based on the Java2D API. + +===REQUIREMENTS=== + +To run Piccolo2D.Java applications you need to have a Java Runtime +Environment (JRE) or Java Development Kit (JDK) version 1.4 or newer. + +To build Piccolo2D.Java you need to have a Java Runtime Environment +(JRE) or Java Development Kit (JDK) version 1.5 or newer, and Apache +Maven version 2.0.10 or newer. + +Java Runtime Environment (JRE)<br/> +http://java.sun.com/javase/downloads/index.jsp#jre + +Java Development Kit (JDK)<br/> +http://java.sun.com/javase/downloads/index.jsp#jdk + +Apache Maven<br/> +http://maven.apache.org/download.html + +For some platforms, including Mac OSX with JDK version 1.6 or +later on x86_64, the Eclipse Standard Widget Toolkit (SWT) version +3.3.0 or later must also be installed manually. + +Eclipse Standard Widget Toolkit<br/> +http://www.eclipse.org/swt/ + +See<br/> +http://code.google.com/p/piccolo2d/wiki/BuildSWTOnMacOSX + +for further details. + + +===USING PICCOLO2D.JAVA=== + +To include the Piccolo2D core classes in your project, use a +dependency of + +{{{ +<dependency> + <groupId>org.piccolo2d</groupId> + <artifactId>piccolo2d-core</artifactId> + <version>1.3</version> +</dependency> +}}} + +in your pom.xml. To include the Piccolo2D core classes and the +Piccolo2D extras classes in your project, use a dependency of + +{{{ +<dependency> + <groupId>org.piccolo2d</groupId> + <artifactId>piccolo2d-extras</artifactId> + <version>1.3</version> +</dependency> +}}} + +in your pom.xml. To include the Piccolo2D core classes and the +Piccolo2D SWT classes in your project, use a dependency of + +{{{ +<dependency> + <groupId>org.piccolo2d</groupId> + <artifactId>piccolo2d-swt</artifactId> + <version>1.3</version> +</dependency> +}}} + +in your pom.xml. If your project does not use maven, simply include +the relevant Piccolo2D jars in your project's classpath. + + +===BUILDING PICCOLO2D.JAVA=== + +To build all the Piccolo2D modules + +{{{ +$ mvn install +}}} + +To build and run the Piccolo2D examples runnable jar + +{{{ +$ cd examples +$ mvn assembly:assembly +$ java -jar target/piccolo2d-examples-1.3-jar-with-dependencies.jar +}}} + +To build and run the Piccolo2D SWT examples runnable jar + +{{{ +$ cd swt-examples +$ mvn assembly:assembly +$ java -jar target/piccolo2d-swt-examples-1.3-jar-with-dependencies.jar +}}} -- Piccolo2D Developers Group: http://groups.google.com/group/piccolo2d-dev?hl=en
