[go: up one dir, main page]

Menu

Tree [r43] / trunk /
 History

HTTPS access


File Date Author Commit
 .settings 2010-04-19 daniel_zardi [r43] 1. Removed Findbugs from project.
 src 2010-04-19 daniel_zardi [r43] 1. Removed Findbugs from project.
 target-cache 2010-04-14 daniel_zardi [r42] Note: The project's configuration is now update...
 target-data 2010-04-19 daniel_zardi [r43] 1. Removed Findbugs from project.
 .checkstyle 2010-04-12 daniel_zardi [r41] Note: Build now works as expected but the confi...
 .classpath 2010-04-12 daniel_zardi [r41] Note: Build now works as expected but the confi...
 .pmd 2010-04-12 daniel_zardi [r41] Note: Build now works as expected but the confi...
 .project 2010-04-12 daniel_zardi [r41] Note: Build now works as expected but the confi...
 README.txt 2010-04-19 daniel_zardi [r43] 1. Removed Findbugs from project.
 TODO.txt 2010-04-19 daniel_zardi [r43] 1. Removed Findbugs from project.
 pom.xml 2010-04-19 daniel_zardi [r43] 1. Removed Findbugs from project.

Read Me

Environment Setup:

Eclipse 3.5.X (Maybe Works With 3.4)
Plugins
	PMD
		http://pmd.sourceforge.net/eclipse/
	Checkstyle
		http://eclipse-cs.sourceforge.net/update/ (5.X)
	TestNG
		http://beust.com/eclipse/
	Maven
		http://m2eclipse.sonatype.org/sites/m2e/
		http://m2eclipse.sonatype.org/sites/m2e-extras/ (WTP and SCM Integrations)

Tools (System Level)
	Maven 2.2.1
		http://maven.apache.org/download.html
	Subversion
		http://subversion.tigris.org/project_packages.html
	Graphviz
		http://www.graphviz.org/Download.php

Eclipse Configuration
	The project should work out of the box. If wanted one can import the configurations used by
	AceLogger into their installation, these files are located under "src/main/config/eclipse"
	(Note that this is not necessary, the configuration is defined at project level). AceLogger uses
	Java 5 compatibility, so it's a good idea to have a JDK 5 installed (but a JDK 6 is fine). To
	choose what VM Libraries will be used with the project go to "Preferences -> Java -> Installed
	JVMs" and search for the VMs installed in your system and then descend to "Execution
	Environments". Now you should check if you have an environment variable called JAVA_HOME and if
	it's pointing to a JDK.

Subversion and Graphviz
	As simple as "Next, Next, Finish". Just don't forget to add them to your environment PATH.

Maven Configuration
	Install (Unpack) Maven to the desired location, go to Eclipse and register your external
	installation "Preferences -> Maven -> Installations -> Add". Now it's time to use your XML
	skills... Go to "~/.m2/settings.xml" (create the file if necessary) and define your local
	repository location (optional) and usernames and password for remote sites used by AceLogger.
	You can find more info about settings can be foud here (http://maven.apache.org/settings.html).
	Your configuration file now should look like this:

	<settings
		xmlns="http://maven.apache.org/SETTINGS/1.0.0"
		xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
		xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
			http://maven.apache.org/xsd/settings-1.0.0.xsd"
	>
		<localRepository>
			path/to/your/repository
		</localRepository>
		<servers>
			<server>
				<id>acelogger.sourceforge.site</id>
				<username>sourceforge_user_name</username>
				<password>sourceforge_password</password>
			</server>
			<server>
				<id>acelogger.sourceforge.repository</id>
				<username>sourceforge_user_name</username>
				<password>sourceforge_password</password>
			</server>
			<server>
				<id>acelogger.sourceforge.repository.snapshot</id>
				<username>sourceforge_user_name</username>
				<password>sourceforge_password</password>
			</server>
		</servers>
	</settings>
	
	Now it's time to encrypt these passwords. Just follow the instructions found in
	(http://maven.apache.org/guides/mini/guide-encryption.html)

Maven Specifics
	Cleaning and Packing works great with the Embedded Maven 3 of the Eclipse Plugin, but site
	generation only works with Maven 2, so you should define run configurations for "site" and
	"site:deploy" goals and use your external Maven.

AceLogger Specifics
	There are some caveats if you want to publish the AceLogger's site to Sourceforge and the first
	is allocating a shell (yeah, you need to request a shell and it lasts for a maximum of 5 hours).
	Follow the instructions in (http://sourceforge.net/apps/trac/sourceforge/wiki/Shell%20service)
	(If you use Putty I recommend saving this configuration, something like "Create Shell for
	AceLogger on Sourceforge"). Now you can connect to (shell.sourceforge.net) via ssh normally.
	Don't forget to accept the certificate because Maven will need it.
	Almost There... I think this should work now, but if it don't try to run the "site:deploy" goal
	from the command line (maybe Maven is requiring some input regarding the ssh connection).

Now You're Ready to Go
	If you're not familiarized with Maven, you should read this
	(http://maven.apache.org/guides/getting-started/maven-in-five-minutes.html)