svn commit: r619596 - /incubator/nmaven/trunk/site/versioned/src/site/apt/getting-started.apt

[si...@apache.org]

Author: sisbell
Date: Thu Feb  7 11:40:34 2008
New Revision: 619596

URL: http://svn.apache.org/viewvc?rev=619596&view=rev
Log:
Updates docs.

Modified:
    incubator/nmaven/trunk/site/versioned/src/site/apt/getting-started.apt

Modified: incubator/nmaven/trunk/site/versioned/src/site/apt/getting-started.apt
URL: http://svn.apache.org/viewvc/incubator/nmaven/trunk/site/versioned/src/site/apt/getting-started.apt?rev=619596&r1=619595&r2=619596&view=diff
==============================================================================
--- incubator/nmaven/trunk/site/versioned/src/site/apt/getting-started.apt (original)
+++ incubator/nmaven/trunk/site/versioned/src/site/apt/getting-started.apt Thu Feb  7 11:40:34 2008
@@ -26,12 +26,20 @@
 
   [[2]] For Microsoft builds you will need both {{{http://msdn2.microsoft.com/en-us/downloads/default.aspx} Microsoft .NET Framework}} (1.1+)
      AND {{{http://msdn2.microsoft.com/en-us/downloads/default.aspx} NET Framework SDK}}. For Mono builds, you will need
-     {{{http://www.mono-project.com} Mono}} (1.2.3.1+).
+     {{{http://www.mono-project.com} Mono}} (tested with 1.2.3.1+).
 
   [[3]] Subversion client 1.3+. Click here for
  {{{ http://subversion.tigris.org/servlets/ProjectDocumentView?documentID=35379&showInfo=true} Windows Subversion Client}}.
 
-  [[4]] {{{http://maven.apache.org/download.html} Maven 2.0.7 or higher}}
+  [[4]] {{{http://maven.apache.org/download.html} Maven 2.0.7+}}
+
+[]
+
+  Optional programs:
+
+  [[1]] {{{http://nunit.org/index.php?p=download} NUnit 2.4.x+}} (Currently only supported building with Microsoft)
+
+** Paths
 
  You will need to make sure that you have both the SDK and the .NET framework locations within your path.
  On Linux distributions, this should already be in your path. Typical locations for Microsoft include:
@@ -46,6 +54,10 @@
 
  * install root/SDK path: C:\Program Files\Mono-1.2.3.1\bin
 
+ []
+
+ If you are using NUnit, add the NUnit bin to your path.
+
 ** Build
 
     To build NMaven:
@@ -62,10 +74,16 @@
   mvn install
 +----+
 
+ To run with integration tests:
+
++----+
+  mvn install -P run-its
++----+
+
 ** Linux Specific Setup
 
  Building on Linux, may take some extra steps. By default, on many Linux environments, the GNU Compiler for Java is already
- installed. The current GNU version will not work with NMaven. To check which version the system uses, type "java -version"
+ installed. The current GNU version may not work with NMaven, which requires JDK 1.5. To check which version the system uses, type "java -version"
  on the command line. If you see something similar to the following, you will need to take additional steps to get the
  build setup:
 
@@ -92,9 +110,9 @@
 Java HotSpot(TM) Client VM (build 1.5.0_09-b01, mixed mode, sharing)
 +----+
 
- On Linux, you also need Mono version 2.1.3.1 or higher. Type "mono -V" on the command line to see what version you
- are running. If it is below 2.1.3.1, then download the latest mono version, unzip and run rpm from the commandline.
- Detailed instructions are located here:
+ You can try to build with the default version of Mono installed. If it doesn't work,
+ type "mono -V" on the command line to see what version you are running. If it is below 1.2.3.1, then download the
+ latest mono version, unzip and run rpm from the commandline. Detailed instructions are located here:
  {{{ http://www.mono-project.com/Getting_Mono}Installing Mono}}. Make sure to su to root before installing with these
  instructions!
 
@@ -111,7 +129,7 @@
 
 +----+
   <build>
-    <sourceDirectory>src/main/csharp</sourceDirectory>
+    <sourceDirectory>.</sourceDirectory>
     <plugins>
       <plugin>
         <groupId>org.apache.maven.dotnet.plugins</groupId>
@@ -127,7 +145,6 @@
 
  Key signing is currently only supported for .NET framework 2.0.
 
-
 * {Assembly Info}
 
  Provided that you do not have your own AssemblyInfo class in your project, NMaven will automatically generate
@@ -181,6 +198,7 @@
   <name>NMaven.It.It0000</name>
   <build>
     <sourceDirectory>.</sourceDirectory>
+    <testSourceDirectory>Test</testSourceDirectory>
     <plugins>
       <plugin>
         <groupId>org.apache.maven.dotnet.plugins</groupId>
@@ -192,6 +210,22 @@
 </project>
 +----+
 
+ If you are using Mono on Windows, then set the vendor tag. If you are compiling on a non-Windows platform, then you do not need to set the
+ tag.
+
++----+
+<plugins>
+  <plugin>
+    <groupId>org.apache.maven.dotnet.plugins</groupId>
+    <artifactId>maven-dotnet-compiler-plugin</artifactId>
+    <extensions>true</extensions>
+    <configuration>
+      <vendor>NOVELL</vendor>
+    </configuration>
+  </plugin>
+</plugins>
++----+
+
 * {Project Dependencies}
 
  To use a gac dependency, you will need to set a GAC_ROOT environment variable to point to either the Microsoft or Mono
@@ -228,7 +262,27 @@
 
 * {NUnit}
 
+ NUnit is currently only supported building with Microsoft, not Mono. To use, add the following dependency to the pom.
+
++----+
+<dependency>
+    <groupId>org.apache.maven.dotnet</groupId>
+    <artifactId>NUnit.Framework</artifactId>
+    <version>2.4.6-incubating-SNAPSHOT</version>
+    <type>dotnet:library</type>
+    <scope>test</scope>
+</dependency>
++----+
 
+ And also set the test source directory to where your test classes are located.
+
++----+
+  <build>
+    <sourceDirectory>.</sourceDirectory>
+    <testSourceDirectory>Test</testSourceDirectory>
+...
+  </build>
++----+
 
 * {Archetypes}