Project

General

Profile

Getting Started » History » Revision 3

Revision 2 (Johannes Schmölz, 10/29/2012 04:41 PM) → Revision 3/9 (Johannes Schmölz, 10/30/2012 05:24 PM)

h1. Getting Started 

 This guide will give you a short briefing of how to get your development environment up and running within a few minutes. 


 h2. Basic Setup 

 For the basic setup of your development environment you need to obtain the following tools and programmes: 

 * The "Java Development Kit":http://www.oracle.com/technetwork/java/javase/downloads/index.html (JDK) version 6 or higher 
 * A text editor or an IDE 
 * "Maven":http://maven.apache.org/ 
 * "Git":http://git-scm.com/ 

 Since the setup process of the development environment is dependent on the operating system used, you will find the instructions for different systems (Windows, OS X and Linux) below. 


 h3. Windows 

 # Download and install the "Java Development Kit":http://www.oracle.com/technetwork/java/javase/downloads/index.html 
 Version 6 of the JDK is sufficient, but we strongly recommend to use the most recent version. 
 # Get an editor or an IDE of your choice and install it 
 Good IDEs for Java development are "NetBeans":http://www.netbeans.org/ and "Eclipse":http://www.eclipse.org/. If you prefer a pure text editor, "Notepad++":http://notepad-plus-plus.org/ is worth trying. 
 # Download and install the most recent version of "Maven":http://maven.apache.org/ 
 # Download "Git":http://git-scm.com/. 
 There are different options available in order to use Git on Windows: 
 * "Git Extensions":https://code.google.com/p/gitextensions/ 
 Git Extensions is a graphical user interface for Git, that comes with Windows Explorer integration. It is based on "MSysGit":https://code.google.com/p/msysgit/. Our recommendation for Windows users. 
 * "TortoiseGit":https://code.google.com/p/tortoisegit/ 
 TortoiseGit is a port of TortoiseSVN. For those familiar with TortoiseSVN, TortoiseGit is worth trying. It requires "MSysGit":https://code.google.com/p/msysgit/. 
 * "MSysGit":https://code.google.com/p/msysgit/ 
 Git on the command line. 

 You are done! 


 h3. OS X 

 *TODO* 


 h3. Linux 

 On Linux you can use your system's package manager to install all required tools and programmes. Below you will find the commands to do so, based on "aptitude":http://packages.debian.org/aptitude, a front-end for "Debian's":http://www.debian.org "Advanced Package Tool":http://wiki.debian.org/Apt (APT).  

 # Install "OpenJDK":http://openjdk.java.net/ 
 OpenJDK 6: @sudo aptitude install openjdk-6-jdk@ 
 OpenJDK 7: @sudo aptitude install openjdk-7-jdk@ 
 If you prefer the Oracle JDK, you have to download and install it manually. You can get from "here":http://www.oracle.com/technetwork/java/javase/downloads/index.html. 
 # Install an editor or an IDE of your choice 
 If you want to use a plain text editor, we recommend "Emacs":https://www.gnu.org/software/emacs/: @sudo aptitude install emacs@ 
 "NetBeans":http://www.netbeans.org/: @sudo aptitude install netbeans@ 
 "Eclipse":http://www.eclipse.org: @sudo aptitude install eclipse@ 
 *Note:* If you want to use the most recent version of "NetBeans":http://www.netbeans.org/ or "Eclipse":http://www.eclipse.org, which is recommended, you should obtain the installer packages from the official websites and perform a manual installation. 
 # Install "Maven":http://maven.apache.org/ 
 @sudo aptitude install maven@ 
 # Install "Git":http://git-scm.com/ 
 @sudo aptitude install git@ 

 You are done! *TODO* 


 h2. Configuration 

 *TODO* 


 h2. Further Reading 

 *TODO*