Added documentation.

larzw · Nov 4, 2016 · 77dcb7e · 77dcb7e
1 parent 3757f03
commit 77dcb7e
Show file tree

Hide file tree

Showing 13 changed files with 138 additions and 8 deletions.
diff --git a/Documentation/Contributing.md b/Documentation/Contributing.md
@@ -0,0 +1 @@
+# Contributing
diff --git a/Documentation/Images/CakePaketLogo.png b/Documentation/Images/CakePaketLogo.png
diff --git a/Documentation/QuickStart.md b/Documentation/QuickStart.md
@@ -0,0 +1 @@
+# Quick Start
diff --git a/Documentation/index.md b/Documentation/index.md
@@ -0,0 +1,11 @@
+<p align="center">
+  <img src="./Images/CakePaketLogo.png" />
+</p>
+
+# Cake.Paket
+
+Adds [Paket](https://fsprojects.github.io/Paket/) support to [Cake](http://cakebuild.net/) via a Cake addin and module.
+
+# Master Branch
+
+The master branch status can be found on [README.md](https://github.com/larzw/Cake.Paket/blob/master/README.md).
diff --git a/README.md b/README.md
@@ -1,2 +1,33 @@
+<p align="center">
+  <img src="./Documentation/Images/CakePaketLogo.png" />
+</p>
+
 # Cake.Paket
-Adds paket support to cake.
+
+Adds [Paket](https://fsprojects.github.io/Paket/) support to [Cake](http://cakebuild.net/) via a Cake addin and module.
+
+# Master Branch
+
+|Tool|Information|Badge|
+|:--:|:--:|:--:|
+|AppVeyor|Windows Build|[![AppVeyor branch](https://img.shields.io/appveyor/ci/larzw/cake-paket/master.svg)](https://ci.appveyor.com/project/larzw/cake-paket/branch/master)|
+|Issues|Open Issues|[![GitHub issues](https://img.shields.io/github/issues/larzw/Cake.Paket.svg)](https://github.com/larzw/Cake.Paket/issues)|
+|Read the Docs|Documentation|[![Documentation Status](https://readthedocs.org/projects/cakepaket/badge/?version=latest)](http://cakepaket.readthedocs.io/en/latest/?badge=latest)|
+|Coverall|Code Coverage|[![Coveralls branch](https://img.shields.io/coveralls/larzw/Cake.Paket/master.svg)](https://coveralls.io/github/larzw/Cake.Paket?branch=master)|
+|NuGet|package|[![NuGet](https://img.shields.io/nuget/v/Nuget.Core.svg)]()
+|Gitter|Questions|[![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg?maxAge=2592000)](https://gitter.im/larzw/Lobby)|
+
+# Quick Start
+
+See the [Quick Start](http://cakepaket.readthedocs.io/en/latest/QuickStart/) guide.
+
+# Documentation
+
+See the [Documentation](http://cakepaket.readthedocs.io/en/latest/) for additional help.
+
+# Contributing
+
+All types of contributions are welcome! Please see the [Contributing](http://cakepaket.readthedocs.io/en/latest/Contributing/) guidlines.
+
+# Questions
+Feel free to open an [issue](https://github.com/larzw/Cake.Paket/issues) or contact me via [Gitter](https://gitter.im/larzw/Lobby)
diff --git a/Source/Cake.Paket.Addin/Cake.Paket.Addin.csproj b/Source/Cake.Paket.Addin/Cake.Paket.Addin.csproj
@@ -22,6 +22,7 @@
     <WarningLevel>4</WarningLevel>
     <DocumentationFile>bin\Debug\Cake.Paket.Addin.XML</DocumentationFile>
     <RunCodeAnalysis>true</RunCodeAnalysis>
+    <CodeAnalysisRuleSet>..\Cake.Paket.ruleset</CodeAnalysisRuleSet>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
     <DebugType>pdbonly</DebugType>
@@ -30,6 +31,7 @@
     <DefineConstants>TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
+    <CodeAnalysisRuleSet>..\Cake.Paket.ruleset</CodeAnalysisRuleSet>
   </PropertyGroup>
   <ItemGroup>
     <Reference Include="System" />
@@ -56,7 +58,7 @@
   </Target>
   -->
   <ItemGroup>
-    <AdditionalFiles Include="..\..\stylecop.json" />
+    <AdditionalFiles Include="..\stylecop.json" />
   </ItemGroup>
   <Choose>
     <When Condition="$(TargetFrameworkIdentifier) == '.NETFramework' And ($(TargetFrameworkVersion) == 'v4.5' Or $(TargetFrameworkVersion) == 'v4.5.1' Or $(TargetFrameworkVersion) == 'v4.5.2' Or $(TargetFrameworkVersion) == 'v4.5.3' Or $(TargetFrameworkVersion) == 'v4.6' Or $(TargetFrameworkVersion) == 'v4.6.1' Or $(TargetFrameworkVersion) == 'v4.6.2' Or $(TargetFrameworkVersion) == 'v4.6.3')">
@@ -80,4 +82,7 @@
       <Paket>True</Paket>
     </Analyzer>
   </ItemGroup>
+  <ItemGroup>
+    <None Include="Cake.Paket.Addin.ruleset" />
+  </ItemGroup>
 </Project>
diff --git a/Source/Cake.Paket.Addin/paket.template b/Source/Cake.Paket.Addin/paket.template
@@ -7,10 +7,10 @@ description Paket addin for Cake.
 summary Cake addin that extends Cake with ability to use paket.
 licenseUrl https://github.com/larzw/Cake.Paket/blob/master/LICENSE
 projectUrl https://github.com/larzw/Cake.Paket
-iconUrl https://raw.githubusercontent.com/cake-build/graphics/master/png/cake-medium.png
+iconUrl https://github.com/larzw/Cake.Paket/blob/master/Documentation/Images/CakePaketLogo.png
 requireLicenseAcceptance false
 copyright Copyright (c) 2016 Larz White
 releaseNotes Initial alpha Release.
 tags Cake Script Build paket
 files
-	bin/Release/Cake.Paket.Addin.dll
+	bin/Release/Cake.Paket.Addin.dll
diff --git a/Source/Cake.Paket.Module/Cake.Paket.Module.csproj b/Source/Cake.Paket.Module/Cake.Paket.Module.csproj
@@ -22,6 +22,7 @@
     <WarningLevel>4</WarningLevel>
     <DocumentationFile>bin\Debug\Cake.Paket.Module.XML</DocumentationFile>
     <RunCodeAnalysis>true</RunCodeAnalysis>
+    <CodeAnalysisRuleSet>..\Cake.Paket.ruleset</CodeAnalysisRuleSet>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
     <DebugType>pdbonly</DebugType>
@@ -30,6 +31,7 @@
     <DefineConstants>TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
+    <CodeAnalysisRuleSet>..\Cake.Paket.ruleset</CodeAnalysisRuleSet>
   </PropertyGroup>
   <ItemGroup>
     <Reference Include="System" />
@@ -55,7 +57,7 @@
   </Target>
   -->
   <ItemGroup>
-    <AdditionalFiles Include="..\..\stylecop.json" />
+    <AdditionalFiles Include="..\stylecop.json" />
   </ItemGroup>
   <Choose>
     <When Condition="$(TargetFrameworkIdentifier) == '.NETFramework' And ($(TargetFrameworkVersion) == 'v4.5' Or $(TargetFrameworkVersion) == 'v4.5.1' Or $(TargetFrameworkVersion) == 'v4.5.2' Or $(TargetFrameworkVersion) == 'v4.5.3' Or $(TargetFrameworkVersion) == 'v4.6' Or $(TargetFrameworkVersion) == 'v4.6.1' Or $(TargetFrameworkVersion) == 'v4.6.2' Or $(TargetFrameworkVersion) == 'v4.6.3')">

diff --git a/Source/Cake.Paket.Module/paket.template b/Source/Cake.Paket.Module/paket.template
@@ -7,10 +7,10 @@ description Paket module for cake.
 summary Cake module that extends Cake with ability to use paket.
 licenseUrl https://github.com/larzw/Cake.Paket/blob/master/LICENSE
 projectUrl https://github.com/larzw/Cake.Paket
-iconUrl https://raw.githubusercontent.com/cake-build/graphics/master/png/cake-medium.png
+iconUrl https://github.com/larzw/Cake.Paket/blob/master/Documentation/Images/CakePaketLogo.png
 requireLicenseAcceptance false
 copyright Copyright (c) 2016 Larz White
 releaseNotes Initial alpha Release.
 tags Cake Script Build paket
 files
-	bin/Release/Cake.Paket.Module.dll
+	bin/Release/Cake.Paket.Module.dll
diff --git a/Source/Cake.Paket.UnitTests/Cake.Paket.UnitTests.csproj b/Source/Cake.Paket.UnitTests/Cake.Paket.UnitTests.csproj
@@ -22,6 +22,7 @@
     <WarningLevel>4</WarningLevel>
     <DocumentationFile>bin\Debug\Cake.Paket.UnitTests.XML</DocumentationFile>
     <RunCodeAnalysis>true</RunCodeAnalysis>
+    <CodeAnalysisRuleSet>..\Cake.Paket.ruleset</CodeAnalysisRuleSet>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
     <DebugType>pdbonly</DebugType>
@@ -30,6 +31,7 @@
     <DefineConstants>TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
+    <CodeAnalysisRuleSet>..\Cake.Paket.ruleset</CodeAnalysisRuleSet>
   </PropertyGroup>
   <ItemGroup>
     <Reference Include="System" />
@@ -55,7 +57,7 @@
   </Target>
   -->
   <ItemGroup>
-    <AdditionalFiles Include="..\..\stylecop.json" />
+    <AdditionalFiles Include="..\stylecop.json" />
   </ItemGroup>
   <ItemGroup>
     <Folder Include="Cake.Paket.Module\" />

diff --git a/Source/Cake.Paket.ruleset b/Source/Cake.Paket.ruleset
@@ -0,0 +1,70 @@
+<?xml version="1.0" encoding="utf-8"?>
+<RuleSet Name="Rules for Cake.Paket" Description="Code analysis rules for Cake.Paket" ToolsVersion="14.0">
+  <Rules AnalyzerId="Microsoft.Analyzers.ManagedCodeAnalysis" RuleNamespace="Microsoft.Rules.Managed">
+    <Rule Id="CA1001" Action="Warning" />
+    <Rule Id="CA1009" Action="Warning" />
+    <Rule Id="CA1016" Action="Warning" />
+    <Rule Id="CA1033" Action="Warning" />
+    <Rule Id="CA1049" Action="Warning" />
+    <Rule Id="CA1060" Action="Warning" />
+    <Rule Id="CA1061" Action="Warning" />
+    <Rule Id="CA1063" Action="Warning" />
+    <Rule Id="CA1065" Action="Warning" />
+    <Rule Id="CA1301" Action="Warning" />
+    <Rule Id="CA1400" Action="Warning" />
+    <Rule Id="CA1401" Action="Warning" />
+    <Rule Id="CA1403" Action="Warning" />
+    <Rule Id="CA1404" Action="Warning" />
+    <Rule Id="CA1405" Action="Warning" />
+    <Rule Id="CA1410" Action="Warning" />
+    <Rule Id="CA1415" Action="Warning" />
+    <Rule Id="CA1821" Action="Warning" />
+    <Rule Id="CA1900" Action="Warning" />
+    <Rule Id="CA1901" Action="Warning" />
+    <Rule Id="CA2002" Action="Warning" />
+    <Rule Id="CA2100" Action="Warning" />
+    <Rule Id="CA2101" Action="Warning" />
+    <Rule Id="CA2108" Action="Warning" />
+    <Rule Id="CA2111" Action="Warning" />
+    <Rule Id="CA2112" Action="Warning" />
+    <Rule Id="CA2114" Action="Warning" />
+    <Rule Id="CA2116" Action="Warning" />
+    <Rule Id="CA2117" Action="Warning" />
+    <Rule Id="CA2122" Action="Warning" />
+    <Rule Id="CA2123" Action="Warning" />
+    <Rule Id="CA2124" Action="Warning" />
+    <Rule Id="CA2126" Action="Warning" />
+    <Rule Id="CA2131" Action="Warning" />
+    <Rule Id="CA2132" Action="Warning" />
+    <Rule Id="CA2133" Action="Warning" />
+    <Rule Id="CA2134" Action="Warning" />
+    <Rule Id="CA2137" Action="Warning" />
+    <Rule Id="CA2138" Action="Warning" />
+    <Rule Id="CA2140" Action="Warning" />
+    <Rule Id="CA2141" Action="Warning" />
+    <Rule Id="CA2146" Action="Warning" />
+    <Rule Id="CA2147" Action="Warning" />
+    <Rule Id="CA2149" Action="Warning" />
+    <Rule Id="CA2200" Action="Warning" />
+    <Rule Id="CA2202" Action="Warning" />
+    <Rule Id="CA2207" Action="Warning" />
+    <Rule Id="CA2212" Action="Warning" />
+    <Rule Id="CA2213" Action="Warning" />
+    <Rule Id="CA2214" Action="Warning" />
+    <Rule Id="CA2216" Action="Warning" />
+    <Rule Id="CA2220" Action="Warning" />
+    <Rule Id="CA2229" Action="Warning" />
+    <Rule Id="CA2231" Action="Warning" />
+    <Rule Id="CA2232" Action="Warning" />
+    <Rule Id="CA2235" Action="Warning" />
+    <Rule Id="CA2236" Action="Warning" />
+    <Rule Id="CA2237" Action="Warning" />
+    <Rule Id="CA2238" Action="Warning" />
+    <Rule Id="CA2240" Action="Warning" />
+    <Rule Id="CA2241" Action="Warning" />
+    <Rule Id="CA2242" Action="Warning" />
+  </Rules>
+  <Rules AnalyzerId="StyleCop.Analyzers" RuleNamespace="StyleCop.Analyzers">
+    <Rule Id="SA1101" Action="None" />
+  </Rules>
+</RuleSet>
diff --git a/stylecop.json → Source/stylecop.json b/stylecop.json → Source/stylecop.json
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,7 @@
+site_name: Cake.Paket
+repo_url: https://github.com/larzw/Cake.Paket
+docs_dir: Documentation
+pages:
+    - 'Introduction': 'index.md'
+    - 'Quick Start': 'QuickStart.md'
+    - 'Contributing': 'Contributing.md'