Permalink
Browse files

added readme and updated nuget specs

  • Loading branch information...
1 parent a371b0e commit 6eec6929eb964fdd367ffccdcfd47669cb34f804 @jmarnold jmarnold committed Aug 24, 2011
Showing with 58 additions and 6 deletions.
  1. +3 −3 packaging/nuget/fubumvc.validation.nuspec
  2. +3 −3 packaging/nuget/fubuvalidation.nuspec
  3. +52 −0 readme.md
@@ -3,14 +3,14 @@
<metadata xmlns="http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd">
<id>FubuMVC.Validation</id>
<version>0.0</version>
- <authors>Chad Myers, Jeremy D. Miller, Joshua Flanagan</authors>
- <owners>Joshua Flanagan</owners>
+ <authors>Joshua Arnold, et al.</authors>
+ <owners>Joshua Arnold</owners>
<licenseUrl>https://raw.github.com/DarthFubuMVC/fubuvalidation/master/license.txt</licenseUrl>
<projectUrl>http://fubumvc.com</projectUrl>
<iconUrl>https://github.com/DarthFubuMVC/fubumvc/raw/master/doc/logo/FubuMVC_Logo_package_icon.png</iconUrl>
<requireLicenseAcceptance>false</requireLicenseAcceptance>
<description>A FubuMVC implementation of FubuValidation</description>
- <tags>fubumvc mvc nhibernate</tags>
+ <tags>fubumvc mvc fubu validation conventional</tags>
<dependencies>
<dependency id="fubumvc.references" />
<dependency id="fubuvalidation" />
@@ -3,14 +3,14 @@
<metadata xmlns="http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd">
<id>FubuValidation</id>
<version>0.0</version>
- <authors>Chad Myers, Jeremy D. Miller, Joshua Flanagan</authors>
- <owners>Joshua Flanagan</owners>
+ <authors>Joshua Arnold, Jeremy D. Miller, et al.</authors>
+ <owners>Joshua Arnold, Jeremy D. Miller</owners>
<licenseUrl>https://raw.github.com/DarthFubuMVC/fubuvalidation/master/license.txt</licenseUrl>
<projectUrl>http://fubumvc.com</projectUrl>
<iconUrl>https://github.com/DarthFubuMVC/fubumvc/raw/master/doc/logo/FubuMVC_Logo_package_icon.png</iconUrl>
<requireLicenseAcceptance>false</requireLicenseAcceptance>
<description>FubuValidation - have validation your way, whatever way that happens to be</description>
- <tags>fubumvc mvc nhibernate</tags>
+ <tags>fubu validation fubumvc conventional</tags>
<dependencies>
<dependency id="fubulocalization" />
<dependency id="htmltags" />
View
@@ -0,0 +1,52 @@
+# FubuValidation
+
+## What is FubuValidation?
+
+FubuValidation is a member of the Fubu-family of frameworks -- frameworks that aim to get out of your way by providing rich semantic models with powerful convention-driven operations. It aims to provide a convention-driven approach to validation while supporting more traditional approaches when needed.
+
+> An important thing to note: FubuValidation is NOT coupled to FubuMVC. In fact, it maintains no references to the project.
+
+## What is FubuMVC.Validation?
+
+FubuMVC.Validation is a package that adapts FubuValidation to the FubuMVC framework and provides out-of-to-the-box support for many common validation scenarios (both ajax and non-ajax).
+
+## Get it on NuGet
+
+You can clone our repo and build from scratch, or you can use our NuGet packages:
+
+* FubuValidation - The core validation framework
+* FubuMVC.Validation - FubuMVC specific uses for FubuValidation
+
+## Using FubuMVC.Validation
+
+While we recommend that you take a look at our sample project in this repository, you can bootstrap validation for your application through your FubuRegistry using our convenient extension methods:
+
+ this.Validation(validation => {
+ });
+
+## Why does `git status` show that all of my files are modified?
+
+The Fubu-family of frameworks are built by Windows users, so all of the text files have CRLF line endings. These line endings are stored as-is in git (which means we all have autocrlf turned off).
+If you have autocrlf enabled, when you retrieve files from git, it will modify all of your files. Your best bet is to turn off autocrlf, and re-create your clone of FubuMVC.
+
+1. Delete your local clone of the repository
+1. Type: `git config --global core.autocrlf false`
+1. Type: `git config --system core.autocrlf false`
+1. Clone the repository again
+
+[More information about working with git and FubuMVC](http://groups.google.com/group/fubumvc-devel/browse_thread/thread/606000f0803adf31/a09fce24e468ea20?#a09fce24e468ea20)
+
+
+## Where is CommonAssemblyInfo.cs?
+
+CommonAssemblyInfo.cs is generated by the build. The build script requires Ruby with rake installed.
+
+1. Run `InstallGems.bat` to get the ruby dependencies (only needs to be run once per computer)
+1. open a command prompt to the root folder and type `rake` to execute rakefile.rb
+
+If you do not have ruby:
+
+1. You need to manually create a src\CommonAssemblyInfo.cs file
+
+ * type: `echo // > src\CommonAssemblyInfo.cs`
+1. open src\FubuValidation.sln with Visual Studio and Build the solution

0 comments on commit 6eec692

Please sign in to comment.