forked from autofac/Autofac
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdevelopers.html
160 lines (150 loc) · 5.4 KB
/
developers.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>Readme for Autofac Developers</title>
<style type="text/css">
<!--
body
{
font-family: Calibri;
background-color: white;
color: black;
font-size: 11pt;
padding-left: 10pt;
padding-right: 10pt;
}
h1, h2, h3, h4, h5, h6
{
font-family: Cambria;
}
h1, h2, h3, h4
{
font-weight: bold;
}
h2, h3, h4
{
color: #4F81BD;
}
h3, h4, h5, h6
{
font-size: 11pt;
}
h4, h6
{
font-style: italic;
}
h5, h6
{
color: #17365D;
font-weight: normal;
}
h1
{
font-size: 14pt;
color: #365F91;
border-bottom: 1px solid black;
margin-top: 26pt;
}
h2
{
font-size: 13pt;
}
h1.title
{
font-size: 26pt;
font-weight: normal;
color: #17365D;
border-bottom: 1px solid #4F81BD;
}
table
{
border-collapse: collapse;
border: 1px solid gray;
}
table thead th
{
padding: 2pt 4pt 2pt 4pt;
border-bottom: 1px solid gray;
}
table tbody td
{
padding: 2pt 4pt 2pt 4pt;
vertical-align: top;
border-bottom: 1px solid lightgray;
}
table tbody tr:last-child td
{
border-bottom: 1px solid gray;
}
div.callout
{
margin: 5pt 20pt 5pt 20pt;
padding-left: 5pt;
padding-right: 5pt;
border: 1px solid black;
background-color: lightgray;
}
.footnote
{
font-size: 8pt;
}
.footnote p
{
text-indent: -10pt;
padding-left: 10pt;
}
-->
</style>
</head>
<body>
<h1 class='title'>Readme for Autofac Developers</h1>
<p>This document explains the developer setup and build execution for Autofac.</p>
<h1>Developer Environment</h1>
<ul>
<li>Visual Studio 2013 (Premium/Ultimate), which includes:
<ul>
<li>.NET 4.5</li>
<li>WCF RIA Services</li>
<li>Portable Class Library tooling</li>
<li>FxCop</li>
</ul>
</li>
<li><a href="http://www.microsoft.com/en-us/download/details.aspx?id=35471">Windows Phone 8 SDK</a></li>
<li><a href="http://nunit.org/index.php?p=vsTestAdapter&r=2.6.3">NUnit Test Adapter for VS11</a> (optional - to run unit tests inside Visual Studio)</li>
<li><a href="http://www.microsoft.com/en-us/download/details.aspx?id=29062">SQL Server Express 2012</a> (for demo applications)</li>
</ul>
<h1>Building the Project</h1>
<p>Developer build:<br />
<code>msbuild default.proj</code></p>
<p>Production/Release build:<br />
<code>msbuild default.proj /p:Production=true</code></p>
<p>The <strong>developer build</strong> will...</p>
<ul>
<li>Clean all build artifacts.</li>
<li>Build the solution.</li>
<li>Execute the unit tests.</li>
<li>Run code analysis.</li>
</ul>
<p>The <strong>production/release build</strong> will do everything in the developer build <em>plus</em>...</p>
<ul>
<li>Create zip packages for distribution.</li>
<li>Create NuGet packages for distribution.</li>
<li>Build the compiled API help documentation.</li>
</ul>
<p><strong>Note for developers:</strong> If you are working on the Autofac core, there is also a project in Core/Tests/Autofac.Tests.AppCert that should be built/run separately to verify changes will pass Windows App Store certification. This build is not chained into the standard developer build since it takes time to run. <a href="Core/Tests/Autofac.Tests.AppCert/readme.html">There is a readme in that folder explaining more about how to run that build and assess results</a>.</p>
<p>Production package versions are centrally controlled through the <code>PackageVersions.proj</code>. Documentation in that
file explains how to use it. Before releasing new versions for consumption, be sure to update the appropriate version(s).</p>
<h1>Updating the API Documentation Site</h1>
<p>The API docs are viewable at <a href="http://api.autofac.org">http://api.autofac.org</a>. This is hosted on GitHub pages in the <a href="https://github.com/autofac/autofac.github.com">https://github.com/autofac/autofac.github.com</a> repository.</p>
<ol>
<li>Build the API documentation.</li>
<li>Update the contents in the <code>/apidoc</code> folder with the new docs (add/remove/update).</li>
<li>Make sure the index page in the <code>/apidoc</code> is <code>index.html</code> - lower case, full <code>html</code> extension. (By default, Sandcastle makes it <code>Index.htm</code> which doesn't work.)</li>
</ol>
<h1>Updating the User Documentation Site</h1>
<p>User documentation is viewable at <a href="https://docs.autofac.org">https://docs.autofac.org</a> (a CNAME to <a href="https://autofac.readthedocs.org">https://autofac.readthedocs.org</a>). It is stored in the <code>/docs</code> folder in this source repo.</p>
<p>To build the docs and see them locally, you need to follow the <a href="https://docs.readthedocs.org/en/latest/getting_started.html">Getting Started</a> docs on Read The Docs so you get Python and Sphinx installed.</p>
<p>The docs are written in <a href="http://sphinx-doc.org/rest.html">reStructuredText</a>, which is very similar to Markdown but not quite. Check that out for a primer.</p>
<p>Updates to the documentation checked into the <code>/docs</code> folder will automatically propagate to Read The Docs. No build or separate push is required.</p>
</body>
</html>