AMQNET-562 Update NOTICE file
[activemq-nms-msmq.git] / README.txt
index 329bfa4a599d37e7f34793aa46de939037e874b5..a181af18210f59ed6928308430ed67350f5b5fa6 100644 (file)
@@ -1,86 +1,58 @@
 =======================================================================
 Welcome to:
- * NMS API : The .NET Messaging Service API
- * NMS Client for Apache ActiveMQ
- * NMS Client for MSMQ
+ * Apache.NMS.MSMQ : Apache NMS for MSMQ Client Library
 =======================================================================
 
-For more information see http://activemq.apache.org/nms.html
+For more information see http://activemq.apache.org/nms
 
 =======================================================================
-Building With Visual Stuido 2005
+Building With NAnt 0.86 see http://nant.sourceforge.net/
 =======================================================================
 
-Open the vs2005.sln Solution File.  Build using "Build"->"Build Solution" 
-menu option.
-
-The resulting DLLs will be in bin\Debug or the bin\Release directories 
-depending on you 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.
+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:
 
-=======================================================================
-Building With SharpDevelop 2.1
-=======================================================================
+  nant
 
-SharpDevelop is an open source IDE that you can download from:
-http://www.sharpdevelop.net/OpenSource/SD/Default.aspx
+To run the unit tests you need to run an Apache ActiveMQ Broker first then run:
 
-Open the sharpdevelop.sln Solution File.  Build using the 
-"Build"->"Build Solution" menu option.
+  nant test
 
-The resulting DLLs will be in bin\Debug or the bin\Release directories 
-depending on you settings under "Build"->"Set Configuration"
+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.
 
-To run the Unit Tests, you must first start an Apache ActiveMQ Broker 
-and then use the "View"->"Tools"->"Unit Tests" menu option.  On the
-newly displayed Unit Tests view, click the "Run tests" button.
+The Sandcastle project is located here:
 
-Note: Seems like the nunit integration in SharpDevelop still needs a 
-little work because on a WindowsXP x64 system, running the tests caused 
-some Unexpected Exception errors.
+http://sandcastle.codeplex.com/
 
-=======================================================================
-Building With monodevelop 
-=======================================================================
+The Sandcastle Styles project is located here:
 
-monodevelop is an open source IDE that you can download from:
-http://www.monodevelop.com/
+http://sandcastlestyles.codeplex.com/
 
-Open the monodevelop.mds Solution File.  Build using the 
-"Run"->"Build Solution" menu option.
+To generate the documentation, run:
 
-The resulting DLLs will be in bin\Debug or the bin\Release directories 
-depending on the configuration you have selected in the Build bar.
+  nant sandcastle-all
 
 =======================================================================
-Building With NAnt
+Building With Visual Studio 2008
 =======================================================================
-To build the code using NAnt type
-
-  nant
-  
-To run the unit tests you need to run an Apache ActiveMQ Broker first then type
-
-  nant test
-  
-To generate the documentation type
 
-  nant doc
+First build the project with nant, this will download and install 
+all the 3rd party dependencies for you.
 
-  
-Assuming that you have checked out the ActiveMQ code and the Site in peer directories such as
+Open the solution File.  Build using "Build"->"Build Solution" 
+menu option.
 
+The resulting DLLs will be in build\${framework}\debug or the 
+build\${framework}\release directories depending on your settings 
+under "Build"->"Configuration Manager"
 
-activemq/
-  activemq-dotnet/
-  
-activemq-site/
-   nms/
-      ndoc/
-      
-So that generating the ndoc will copy the generate content into the ndoc directory so it can be deployed on the Apache website.
+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.  Otherwise,
+the standalone NUnit test runner can be used.  NUnit version 2.5.8
+is required to build and run the unit tests.