AMQNET-562 Update NOTICE file
[activemq-nms-msmq.git] / README.txt
index 9a01bb891902bd1e19e1de3b2fa4370c8110de7f..a181af18210f59ed6928308430ed67350f5b5fa6 100644 (file)
@@ -1,42 +1,58 @@
 =======================================================================
 Welcome to:
- * Apache.NMS.MSMQ : Apache NMS for MSMQ Class Library
+ * Apache.NMS.MSMQ : Apache NMS for MSMQ Client Library
 =======================================================================
 
 For more information see http://activemq.apache.org/nms
 
 =======================================================================
-Building With NAnt 0.86-Beta2 http://nant.sourceforge.net/
+Building With NAnt 0.86 see http://nant.sourceforge.net/
 =======================================================================
 
-A recent nightly build of the NAnt 0.86 beta 2 is required to build Apache.NMS.
-To build the code using NAnt type
+NAnt version 0.86 or newer is required to build Apache.NMS.MSMQ.  Version 0.90
+or newer is highly recommended.
+To build the code using NAnt, run:
 
   nant
-  
-To run the unit tests you need to run an Apache ActiveMQ Broker first then type
+
+To run the unit tests you need to run an Apache ActiveMQ Broker first then run:
 
   nant test
-  
-To generate the documentation type
 
-  nant doc
+The NMS documentation can be generated into three different formats using
+Microsoft's Sandcastle open source product. The Sandcastle Styles project
+was used to enhance the output generated from the current release of Sandcastle.
+
+The Sandcastle project is located here:
+
+http://sandcastle.codeplex.com/
+
+The Sandcastle Styles project is located here:
 
+http://sandcastlestyles.codeplex.com/
+
+To generate the documentation, run:
+
+  nant sandcastle-all
 
 =======================================================================
-Building With Visual Stuido 2008
+Building With Visual Studio 2008
 =======================================================================
 
 First build the project with nant, this will download and install 
 all the 3rd party dependencies for you.
 
-Open the Solution File.  Build using "Build"->"Build Solution" 
+Open the solution File.  Build using "Build"->"Build Solution" 
 menu option.
 
-The resulting DLLs will be in bin\Debug or the bin\Release directories 
-depending on your settings under "Build"->"Configuration Manager"
+The resulting DLLs will be in build\${framework}\debug or the 
+build\${framework}\release directories depending on your settings 
+under "Build"->"Configuration Manager"
 
 If you have the Resharper plugin installed in Visual Studio, you can run 
 all the Unit Tests by using the "ReSharper"->"Unit Testing"->"Run All 
 Tests from Solution" menu option.  Please note that you must run an 
-Apache ActiveMQ Broker before kicking off the unit tests.
+Apache ActiveMQ Broker before kicking off the unit tests.  Otherwise,
+the standalone NUnit test runner can be used.  NUnit version 2.5.8
+is required to build and run the unit tests.
+