From: <ldi...@us...> - 2006-03-19 17:56:29
|
Revision: 93 Author: ldikmans Date: 2006-03-19 09:56:20 -0800 (Sun, 19 Mar 2006) ViewCVS: http://svn.sourceforge.net/sensor/?rev=93&view=rev Log Message: ----------- Added documentation for developers Modified Paths: -------------- trunk/sensor-site/xdocs/navigation.xml Added Paths: ----------- trunk/sensor-site/xdocs/developersguide.xml trunk/sensor-site/xdocs/eclipsestart.xml trunk/sensor-site/xdocs/mavenbuild.xml Added: trunk/sensor-site/xdocs/developersguide.xml =================================================================== --- trunk/sensor-site/xdocs/developersguide.xml (rev 0) +++ trunk/sensor-site/xdocs/developersguide.xml 2006-03-19 17:56:20 UTC (rev 93) @@ -0,0 +1,11 @@ +<?xml version="1.0" encoding="utf-8"?> + +<document> + <properties> + <title> Developers Guide</title> + </properties> + + <body> + This guide is meant for developers who want to contribute to Sensor. + </body> +</document> \ No newline at end of file Added: trunk/sensor-site/xdocs/eclipsestart.xml =================================================================== --- trunk/sensor-site/xdocs/eclipsestart.xml (rev 0) +++ trunk/sensor-site/xdocs/eclipsestart.xml 2006-03-19 17:56:20 UTC (rev 93) @@ -0,0 +1,51 @@ +<?xml version="1.0" encoding="utf-8"?> + +<document> + <properties> + <title> Quick start with eclipse </title> + </properties> + + <body> + <section>This quickstart describes the setup for eclipse + + <subsection name="Prerequisites"> + <li>eclipse version 3.1.x or higher</li> + <li>maven 1.0.2 or maven 1.1</li> + </subsection> + + <subsection name="Optional"> + <li>subclipse to download the sources from the subversion repository</li> + <li>WTP </li> + <li>Maviclipse </li> + </subsection> + + <subsection name="Installation in Eclipse"> + <ul> + <li>Create a workspace in eclipse (version 3.1.x or higher)</li> + <li>Preferences: + <ul> + <li>Installed JRE: 1.4.2 or higher.</li> + <li>Create a classpath variable (Java/Build path) in eclipse named: MAVEN_REPO that points to the maven repository.</li> + </ul> + </li> + <li>Use the SVN repository browser and point to https://svn.sourceforge.net/svnroot/sensor </li> + <li>Check out the four (or three) modules into workspace as projects:"</li> + <ul> + <li>sensor-console</li> + <li>sensor-core</li> + <li>sensor-site (if you plan to add documentation) </li> + <li>sensor-support</li> + </ul> + <li> + <links> + <item name="build sensor with maven" href="mavenbuild.html"/> + </links> + </li> + <li>refresh the projects in eclipse</li> + </ul> + Now all the projects should compile in eclipse and you are ready to go! + + </subsection> + </section> + </body> +</document> \ No newline at end of file Added: trunk/sensor-site/xdocs/mavenbuild.xml =================================================================== --- trunk/sensor-site/xdocs/mavenbuild.xml (rev 0) +++ trunk/sensor-site/xdocs/mavenbuild.xml 2006-03-19 17:56:20 UTC (rev 93) @@ -0,0 +1,23 @@ +<?xml version="1.0" encoding="utf-8"?> + +<document> + <properties> + <title> Installation with Maven</title> + </properties> + + <body> + <section> + This paragraph describes building sensor with Maven. + <subsection name="installing the jar files"> + <li>Navigate to the directory of sensor-core and run maven jar:install</li> + <li>Navigate to the directory of sensor-support and run maven jar:install</li> + </subsection> + <subsection name="installing the sensor console"> + Note: this is an unusual situation, usually you would configure the application to run with another application. + <li>Navigate to the directory of sensor-console and run maven war:war</li> + <li>Deploy the application to Tomcat or another J2EE server</li> + <li>Open a browser and point to “http://[host]:[port]/[context-root]/timing/statistics.htm“. For tomcat the URL could be: http://localhost:8080/sensor-console/timing/statistics.htm” </li> + </subsection> + </section> + </body> +</document> \ No newline at end of file Modified: trunk/sensor-site/xdocs/navigation.xml =================================================================== --- trunk/sensor-site/xdocs/navigation.xml 2006-03-19 17:55:54 UTC (rev 92) +++ trunk/sensor-site/xdocs/navigation.xml 2006-03-19 17:56:20 UTC (rev 93) @@ -24,6 +24,10 @@ <menu name="Documentation"> <item name="Getting Started" href="index.html"/> + <item name="Developers Guide" href="developersguide.html" collapse="false"> + <item name="Quick start for Eclipse" href="eclipsestart.html"/> + <item name="Quick start for Maven" href="mavenbuild.html"/> + </item> <item name="Working With Timers" href="index.html" collapse="true"> <item name="Basic API" href="index.html"/> <item name="Applying Timers" href="index.html"/> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |