Browse files

Made final tweaks to documentation, version numbers and added _README…

…_FIRST.txt to help users; the README also subsumed HowToBuild.txt
  • Loading branch information...
1 parent 16ba1c6 commit 4a8b037542c923bf8e9d2e6148cfcbc0ad119cc9 wmccafferty committed Mar 13, 2009
Showing with 39 additions and 15 deletions.
  1. +0 −4 HowToBuild.txt
  2. +3 −3 License.txt
  3. +7 −8 VersionHistory.txt
  4. +29 −0 _README_FIRST.txt
  5. BIN docs/Sharp_Architecture_Reference_Guide.doc
View
4 HowToBuild.txt
@@ -1,4 +0,0 @@
-The file CommonAssemblyInfo.cs is missing from the repository because it is generated automatically.
-
-Before building in Visual Studio you need to run the build either by running go.bat from a command line or double-clicking ClickToBuild.bat.
-Both files do the same thing but ClickToBuild.bat includes a pause so that you can see the results of the build before the window closes.
View
6 License.txt
@@ -1,6 +1,6 @@
-New BSD License for S#arp Architecture
+New BSD License for S#arp Architecture from Codai, Inc.
-Copyright (c) 2008, Codai, LLC
+Copyright (c) 2009, Codai, Inc.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
@@ -13,7 +13,7 @@ are permitted provided that the following conditions are met:
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
- * Neither the name of Codai, LLC nor the names of its
+ * Neither the name of Codai, Inc., nor the names of its
contributors may be used to endorse or promote products derived from this
software without specific prior written permission.
View
15 VersionHistory.txt
@@ -6,21 +6,22 @@ Roadmap for 1.0 GA Release
* Await impatiently for the release of ASP.NET MVC 1.0
* Support multiple databases
-* Add WCF integration example
+* Develop or include a more advanced form binder with CRUD scaffolding
+* Add more examples to Northwind sample project including: WCF, Unit of Work, and Application Services
----------------------------------------------
----------------------------------------------
-1.0 RC 2 (rev 408) - S#arp Architecture for ASP.NET MVC RC 2 with NHibernate 2.0.1
+1.0 RC 2 (rev 409) - S#arp Architecture for ASP.NET MVC RC 2 with NHibernate 2.0.1
----------------------------------------------
----------------------------------------------
Version Acknowledgements:
-* A huge thanks goes out to Kyle Baley and Simone Busoli who have been tremendously assistive to the #Arch community and the project
+* A huge thanks goes out to Kyle Baley and Simone Busoli who have been tremendously assistive to the #Arch community and the project during this recent push
New and exciting in this release:
* Compatible with ASP.NET MVC RC 2
* VS template project includes Fluent NHibernate auto persistence mapping by default
-* Much more powerful and extensible CRUD scaffolding generator - it's completely touch-up free for many scenarios
+* Much more complete and extensible CRUD scaffolding generator - it's completely touch-up free for many scenarios
* Performance of unit tests using SQLite has been improved 20% (thanks Jay Oliver!)
* Added crazy cool anti-forgery voodoo magic to the CRUD scaffolding generator for creating, editing and deleting items (uh, thanks MVC team!)
* New empty class library, called YourProject.ApplicationServices, now gets added to VS generated projects
@@ -32,7 +33,7 @@ Assembly Dependencies:
* ASP.NET MVC RC 2
* ASP.NET MVC RC 1 Futures
* Castle 1.0 RC3 (rev 1038)
-* Fluent NHibernate 0.1 (rev 381)
+* Fluent NHibernate 0.1 (rev 381 - Does NOT include very recent Fluent NHibernate convention interfaces)
* jQuery 1.3.2
* Json.NET 3.5 Beta 2
* Microsoft.Practices.ServiceLocation 1.0 (aka, "Common Service Locator")
@@ -44,14 +45,12 @@ Assembly Dependencies:
* System.Data.SQLite.DLL 1.0.60.0
* T4 Toolbox 9.1.20.1
-There's one known bug associated with the T4 Toolbox described, with work-around, at http://t4toolbox.codeplex.com/WorkItem/View.aspx?WorkItemId=12794.
-
-------
Upgrading to S#arp Architecture RC 2 from Beta (steps also reflected in the Northwind sample project):
#) If you have any previous versions of ASP.NET MVC installed, uninstall them and install ASP.NET MVC RC 2
#) Install NUnit 2.4.8
-#) Upgrade T4 Toolbox to 9.1.20.1 and patch it, following the instructions in the "Installing and Configuring Prerequisites" of the documentation
+#) Upgrade T4 Toolbox to 9.1.20.1 AND PATCH IT, following the instructions in the "Installing and Configuring Prerequisites" of the documentation
#) Update assembly dependencies from trunk/bin into your application's lib and /tools/lib folders
#) Modify using statements from "using NHibernate.Validator;" to "using NHibernate.Validator.Constraints;"
#) Change all reference to anyEntity.ID to anyEntity.Id.
View
29 _README_FIRST.txt
@@ -0,0 +1,29 @@
+--------------------------------------------
+-- Building S#arp Architecture
+--------------------------------------------
+
+BEFORE OPENING /src/SharpArch/SharpArch.sln in Visual Studio 2008 you need to run the build either by running /go.bat from a command line or double-clicking /ClickToBuild.bat.
+
+Both files do the same thing but ClickToBuild.bat includes a pause so that you can see the results of the build before the window closes. The file CommonAssemblyInfo.cs is missing from the solution and is generated automatically by the build process.
+
+--------------------------------------------
+-- How's this release organized?
+--------------------------------------------
+
+* /docs/: Contains comprehensive documentation, Sharp_Architecture_Reference_Guide.doc, and a diagram of what a S#arp Architecture project looks like.
+
+* /bin/: Holds released SharpArch assemblies and third party dependencies needed by a S#arp Architecture project.
+
+* /src/NorthwindSample/: Contains a sample project similar to what's generated by the VS project template. See Sharp_Architecture_Reference_Guide.doc for details.
+
+* /src/SharpArch/: Contains the SharpArch libraries used by S#arp Architecture projects. See Sharp_Architecture_Reference_Guide.doc for details.
+
+* /VisualStudioTemplate/: Contains artifacts for the support of the S#arp Architecture Visual Studio project template and an important fix to the T4 Toolbox (which supports CRUD scaffolding generation).
+
+* /ClickToBuild.bat and /go.bat were discussed above.
+
+* /License.txt: I'll let you guess what this is.
+
+* /SharpArch.build: The NAnt build script used by /go.bat to build the SharpArch class libraries.
+
+* /VersionHistory.txt: Details version numbers of dependencies, changes since previous releases, upgrade details, and a roadmap of what's coming. This is an important document.
View
BIN docs/Sharp_Architecture_Reference_Guide.doc
Binary file not shown.

0 comments on commit 4a8b037

Please sign in to comment.