Merge pull request IntertechInc#9 from wald-tq/Development

Add notes about Development
wald-tq · Jul 13, 2015 · fab28a7 · fab28a7
2 parents b0f2509 + 22958d0
commit fab28a7
Show file tree

Hide file tree

Showing 6 changed files with 55 additions and 1 deletion.
diff --git a/Intertech.Validation/Intertech.Validation.csproj b/Intertech.Validation/Intertech.Validation.csproj
@@ -72,6 +72,7 @@
     <Compile Include="ValidationHelper.cs" />
   </ItemGroup>
   <ItemGroup>
+    <None Include="Intertech.Validation.nuspec" />
     <None Include="packages.config" />
   </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />

diff --git a/Intertech.Validation/Intertech.Validation.nuspec b/Intertech.Validation/Intertech.Validation.nuspec
@@ -0,0 +1,17 @@
+<?xml version="1.0"?>
+<package >
+  <metadata>
+    <id>$id$</id>
+    <version>$version$</version>
+    <title>$title$</title>
+    <authors>$author$</authors>
+    <owners>$author$</owners>
+    <licenseUrl>http://www.apache.org/licenses/LICENSE-2.0</licenseUrl>
+    <projectUrl>https://github.com/IntertechInc/aa-validation-from-server</projectUrl>
+    <requireLicenseAcceptance>false</requireLicenseAcceptance>
+    <description>$description$</description>
+    <releaseNotes>Summary of changes made in this release of the package.</releaseNotes>
+    <copyright>Copyright 2015</copyright>
+    <tags>Intertech validation AngularAgility form external configuration api</tags>
+  </metadata>
+</package>
diff --git a/Intertech.Validation/Properties/AssemblyInfo.cs b/Intertech.Validation/Properties/AssemblyInfo.cs
@@ -8,7 +8,7 @@
 [assembly: AssemblyTitle("Intertech.Validation")]
 [assembly: AssemblyDescription("")]
 [assembly: AssemblyConfiguration("")]
-[assembly: AssemblyCompany("")]
+[assembly: AssemblyCompany("Intertech, Inc")]
 [assembly: AssemblyProduct("Intertech.Validation")]
 [assembly: AssemblyCopyright("Copyright ©  2014")]
 [assembly: AssemblyTrademark("")]

diff --git a/README.md b/README.md
@@ -139,3 +139,7 @@ The controller now can inject validationData since it was resolved in the router
         }
     }
 ```
+
+## Contributing
+
+See file [development.md](development.md) for more infos on the project structure.
diff --git a/aa-validation-from-server.sln b/aa-validation-from-server.sln
@@ -41,6 +41,7 @@ EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{4C7BB457-4636-4990-AAC6-98EDA5B828D5}"
 	ProjectSection(SolutionItems) = preProject
 		.gitignore = .gitignore
+		development.md = development.md
 		README.md = README.md
 	EndProjectSection
 EndProject

diff --git a/development.md b/development.md
@@ -0,0 +1,31 @@
+# Development
+
+## Solution structure
+
+### AATestAPI
+A small WebAPI Project for testing purposes
+
+One simple controller which can be called by URL: 
+http://localhost:52931/api/Validation/GetValidations?dtoObjectName=ValidationTest&jsonObjectName=ObjectName
+
+### AATestSite
+A simple web site.
+
+Can be called at http://localhost:52536/app/index.html
+
+TODO:
+
+* Install required dependencies with bower
+* End-to-end tests?
+
+### Intertech.Validation
+The actual source of the library.
+
+#### Build the NuGet Package
+
+```
+.nuget\NuGet.exe pack Intertech.Validation\Intertech.Validation.csproj
+```
+
+### Intertech.Validation.Test
+The test-project with backend unit-tests
-Original file line number
+Diff line change
@@ Expand Up @@
             }
         }
     ```
+    ## Contributing
+    See file [development.md](development.md) for more infos on the project structure.