Readme and release notes

james-713 · Nov 9, 2011 · 45a828e · 45a828e
1 parent 1ae9fb0
commit 45a828e
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 15 deletions.
diff --git a/README b/README
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -0,0 +1,10 @@
+QuickFIX/n Release Notes
+========================
+
+Welcome to QuickFIX/n
+---------------------
+QuickFIX/n is a .NET port of QuickFIX, an open source C++ FIX engine.
+
+What's New
+----------
+* Initial release of QuickFIX/n
diff --git a/RELEASE_README.md b/RELEASE_README.md
@@ -0,0 +1,22 @@
+QuickFIX/n
+==========
+
+Introduction
+============
+QuickFIX/n implements the FIX protocol on .NET.
+For more information, visit [http://www.quickfixn.org] (http://www.quickfixn.org)
+
+Getting Started
+===============
+Copy bin/QuickFix.dll into your .NET project.
+
+Then read the [documentation] (http://quickfixn.org/tutorial/creating-an-application)
+
+File and Directory Information
+==============================
+* RELEASE_NOTES.md - release notes
+* README - this file
+* LICENSE - license information
+* bin - Contains the QuickFix.dll library
+* config - Contains sample config files for an acceptor or initiator
+* spec - Contains the various FIX data dictionaries
diff --git a/package_release.bat b/package_release.bat
@@ -28,8 +28,9 @@ copy QuickFIX.NET\bin\Release\QuickFix.dll tmp\%QF_DIR%\bin
 xcopy spec tmp\%QF_DIR%\spec /e /y
 copy config\sample_acceptor.cfg tmp\%QF_DIR%\config\
 copy config\sample_initiator.cfg tmp\%QF_DIR%\config\
-copy README tmp\%QF_DIR%\
+copy RELEASE_README.md tmp\%QF_DIR%\README.md
 copy LICENSE tmp\%QF_DIR%\
+copy RELEASE_NOTES.md tmp\%QF_DIR%\
 
 rem Create ZIP
 set ZIP_NAME=%QF_DIR%.zip