|
1 |
| -# WhiteTie |
2 |
| -* No configuration necessary.[**|#ConfigurationNote] |
3 |
| -* By default, White Tie only executes when building in *Release* mode. |
4 |
| -* Provides many MSBuild properties and items, enabling complete customization if desired. |
| 1 | +# White Tie |
| 2 | +Visit the [wiki](../../wiki) for details. |
| 3 | + |
| 4 | +## Features |
| 5 | +* No configuration necessary. [(*)](#configuration-note) |
| 6 | +* By default, White Tie only executes when building in **Release** mode. |
| 7 | +* Builds a NuGet package for your project. (Note that in *Visual Studio 2013*, [NuGet Package Restore](http://docs.nuget.org/docs/reference/package-restore) must be enabled on your solution.) |
| 8 | + * [Code Contract](https://github.com/CodeContractsDotNet/CodeContracts) assemblies, referenced assemblies, symbols, documentation files and NuGet dependency packages are included in the NuGet Package automatically. |
| 9 | + * Additional target framework flavors can be included by adding [`<NuGetFlavor />`](../../wiki/Items#nugetflavor) items to your project. |
| 10 | +* Builds documentation for your project, if [Sandcastle](https://shfb.codeplex.com) is already installed. |
5 | 11 | * Controls whether common static analysis tools are executed.
|
6 |
| -* Builds documentation for your project if [url:Sandcastle|https://shfb.codeplex.com] is installed. |
7 |
| -* Builds a NuGet package for your project (NOTE: In Visual Studio 2013, [url:NuGet Package Restore|http://docs.nuget.org/docs/reference/package-restore] must be enabled on your solution.) |
8 |
| -** [url:Code Contract|https://github.com/CodeContractsDotNet/CodeContracts] assemblies, referenced assemblies, symbols, documentation files and NuGet dependency packages are included in the NuGet Package automatically. |
9 |
| -** Additional target framework flavors can be included by adding {{NuGetFlavor}} items to your project. |
10 |
| -* Copies build output, including any _Content_ project items, to a local deployment directory under the solution. (Note that your project's output folder is unaffected. Output files will also appear in your project's _bin_ folder as normal.) |
| 12 | +* Copies build output, including any `<Content />` project items, to a local deployment directory under the solution. (Note that your project's output folder is unaffected. Output files will also appear in your project's _bin_ folder as normal.) |
11 | 13 | * Uses a consistent solution folder structure for various build dependencies and artifacts.
|
12 |
| -*See also:* |
13 |
| -* [Getting Started|Documentation] |
14 |
| -* [Configuration] |
15 |
| -* [url:How To Videos|https://www.youtube.com/playlist?list=PLzLa5EktSmlzcEuE66oC0YGobqrrwnK2o] |
16 |
| -*{"**"} Configuration Note:*{anchor:ConfigurationNote} |
17 |
| -White Tie generates a _.nuspec_ file with some of the default values derived from attributes in the output assembly. NuGet may generate an error when required values are missing. To avoid these errors, you must either: |
18 |
| -* Include all required assembly attributes as per [url:NuGet's replacement token documentation|http://docs.nuget.org/docs/reference/nuspec-reference/#Replacement_Tokens]. |
19 |
| -* Set the required [MSBuild NuSpec Properties|Configuration#NuSpecProperties] in your project file. |
20 |
| -The first choice is the simplest. In general, you only have to enter non-empty strings for {{AssemblyCompanyAttribute}} and {{AssemblyDescriptionAttribute}} to resolve any errors; however, you should review all of the attributes anyway to ensure that you get the desired output; e.g., {{AssemblyTitleAttribute}}, {{AssemblyCopyrightAttribute}} and {{AssemblyVersionAttribute}} are also used in the NuGet package. |
| 14 | +* Provides many MSBuild properties and items, enabling complete customization if desired. |
| 15 | + |
| 16 | +##### See Also |
| 17 | +* [Getting Started](../../wiki/GettingStarted) |
| 18 | +* [Configuration](../../wiki/Configuration) |
| 19 | +* [How To Videos](https://www.youtube.com/playlist?list=PLzLa5EktSmlzcEuE66oC0YGobqrrwnK2o) |
| 20 | + |
| 21 | +# Configuration Note |
| 22 | +White Tie generates a _.nuspec_ file with some of the default values derived from attributes in the output assembly. NuGet may generate an error when required values are missing. To avoid these errors, you must either: |
| 23 | + |
| 24 | +* Include all required assembly attributes as per [NuGet's replacement token documentation](http://docs.nuget.org/docs/reference/nuspec-reference/#Replacement_Tokens). |
| 25 | +* Set the required [MSBuild NuSpec Properties](../../wiki/Properties#nuspec-properties) in your project file. |
| 26 | + |
| 27 | +The first choice is the simplest. In general, you only have to enter non-empty strings for `AssemblyCompanyAttribute` and `AssemblyDescriptionAttribute` to resolve any errors; however, you should review all of the attributes anyway to ensure that you get the desired output; e.g., `AssemblyTitleAttribute`, `AssemblyCopyrightAttribute` and `AssemblyVersionAttribute` are also used in the NuGet package. |
0 commit comments